1821481 - [1.2] Add telemetry probes for Fullscreen Surface Research

Status: VERIFIED FIXED

(Fenix :: General, enhancement)

Description

[Roger Yang [:royang]]

Add:

1. Telemetry to record when the survey URL is shown to the user.
2. Telemetry to record when the survey URL is closed by the user.
3. Telemetry to record when user clicks the positive button.
4. Telemetry to record when user clicks the negative button.
5. Telemetry to record when user closes the full screen message without agreeing or disagreeing.

Things to consider:

• how will data science determine what full screen message was shown to the user and what full screen message was closed by the user.
• how will data science know how long did the user look at the full screen message.

Comment 1

[Daniela Arcese [:daniela]]

The telemetry should be collected through the messaging framework. iOS is adding an extra for 'surface' so that we can filter based on homepage surface or research surface

Comment 2

[Roger Yang [:royang]]

Confirmed Daniel Berry with the updated requirement:

1. Telemetry to record when the fullscreen message is shown to the user.
2. Telemetry to record when user clicks the positive button.
3. Telemetry to record when user clicks the negative button.

Make sure to distinguish between the homescreen surface and the fullscreen surface.

Comment 3

[Joe M [:jmahon]]

Note from Daniel: the exposure event (#1 above) should happen even when we would have shown the surface even if it's not being displayed (e.g. in the control branch). Said that this is how Messaging already works anyway, but I thought it was worth mentioning for clarity.

Comment 4

[[:skhan]]

The telemetry for messaging was already being recorded for nimbus messages and we will be using the same one here. (No new ones added)
Events:

1. Fullscreen message shown to the user -> messaging.message_shown
2. User clicks positive button (Take Survey) -> messaging.message_clicked
3. User clicks negative button (No Thanks) -> messaging.message_dismissed

Attaching the link to Glean Dictionary for these events : https://dictionary.telemetry.mozilla.org/apps/fenix?itemType=metrics&page=1&search=messaging&showUncollected=1

Comment 5

[miralobontiu]

Verified as fixed on a local release build from 5/4 with a Samsung Galaxy Note 8 (Android 9).

The following events were generated:

• user taps the "No thanks" option - Glean dashboard:

"name": "message_shown",
"message_key": "viewpoint-invitation-message-h123-en"

"category": "messaging",
"name": "message_expired",
"message_key": "viewpoint-invitation-message-h123-en"

"category": "messaging",
"name": "message_dismissed",
"message_key": "viewpoint-invitation-message-h123-en"

• user taps on "Take survey" - Glean dashboard:

"name": "message_shown",
"message_key": "viewpoint-invitation-message-h123-en"

"category": "messaging",
"name": "message_expired",
"message_key": "viewpoint-invitation-message-h123-en"

"category": "messaging",
"name": "message_clicked",
"message_key": "viewpoint-invitation-message-h123-en"

Comment 6

[Chris Peterson [:cpeterson]]

Setting status-firefox113=wontfix because I assume we don't need to uplift these new telemetry probes to Fenix 113 for any experiments.