1849382 - Send an event when a user clicks on a chevron button

Status: RESOLVED FIXED

(Firefox :: Shopping, task, P2)

Description

[Perry McManis [:perry.mcmanis]]

There are currently two chevrons, one to expand the settings card and one to expand the review quality explainer, send Glean events when these are expanded.

Comment 1

[Perry McManis [:perry.mcmanis]]

Attachment: Bug 1849382 - Instrument Shopping Sidebar Chevron Clicks r?jhirsch,travislong

Depends on D186559

Comment 2

[Mike Conley (:mconley) (:⚙️)]

Setting severity to N/A as this is a Task.

Comment 3

[Perry McManis [:perry.mcmanis]]

Attachment: chevron_dr.txt.rtf

I am filing a new data review to cover chevron clicks because I am requesting additional data be collected as an extra key as well as changing the names.

I would like to capture whether the button was used to expand/collapse the cards.

Comment 4

[Travis Long [:travis_]]

Hi Perry, if this is permanent collection then I need an IC responsible for question 7 in the request. Shouldn't this expire in version 122 like all the other shopping telemetry, or is this separate from that?

Also, could you please attach the files as a .txt file instead of .txt.rtf (otherwise I am forced to download the file to view the data-collection request.

Comment 5

[Perry McManis [:perry.mcmanis]]

Attachment: chevron_dr.txt

New data review in the correct format/with correct expiry

Comment 6

[Travis Long [:travis_]]

Comment on attachment 9350451 [details]
chevron_dr.txt

Data Review

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, through the metrics.yaml file and the Glean Dictionary.

2. Is there a control mechanism that allows the user to turn the data collection on and off?

Yes, through the telemetry preferences in the application settings.

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

N/A, collection to end or be renewed by version 122

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 (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?

No

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

Result

data-review+

Comment 7

[Perry McManis [:perry.mcmanis]]

Attachment: Bug 1849382 - Instrument Shopping Sidebar Chevron Clicks

Original Revision: https://phabricator.services.mozilla.com/D186561
Depends on D186559

Depends on D186950

Comment 8

[Phabricator Automation]

Uplift Approval Request

• String changes made/needed: None
• Risk associated with taking this patch: Low.
• Steps to reproduce for manual QE testing: Enable the shopping experience. Perform the action described in the metric description. Send a tagged Events ping in about:glean, verify in debug ping viewer.
• Code covered by automated testing: yes
• Is Android affected?: no
• Needs manual QE test: no
• User impact if declined: Minimal
• Fix verified in Nightly: no
• Explanation of risk level: This is a new component that will not be used by many folks and this code is adding metrics to it. Glean is widely used and has proven reliable. There is automated test coverage over the instrumentation.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/463e81fd4899
Instrument Shopping Sidebar Chevron Clicks r=TravisLong,Gijs

Comment 10

[Cristian Tuns]

Backed out for causing bc failures in browser_ui_telemetry.js

• Backout link
• Push with failures
• Failure Log
• Failure line: TEST-UNEXPECTED-FAIL | browser/components/shopping/tests/browser/browser_ui_telemetry.js | Uncaught exception in test bound test_shopping_UI_chevron_clicks - at chrome://mochitests/content/browser/browser/components/shopping/tests/browser/browser_ui_telemetry.js:45 - TypeError: can't access property "testGetValue", Glean.shopping.surfaceExpandSettings is undefined

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ef429b76d849
Instrument Shopping Sidebar Chevron Clicks r=TravisLong,Gijs

Comment 12

[Natalia Csoregi [:nataliaCs]]

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

Comment 13

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/744de8d56d34

Comment 14

[Peter Magyari (Desktop QA)]

Verified fixed using Firefox Nightly 119.0a1 (2023-09-06) on Windows 10, MacOS 11 and Ubuntu 20.04.

The "surface_show_quality_explainer_clicked" ping with both expanded / collapsed actions is successfully displayed in Glean after clicking the "How do we determine review quality" chevron to expand/collapse the dropdown.

The "surface_settings_expand_clicked" ping with both expanded / collapsed actions is also successfully displayed in Glean after clicking the "Settings" chevron to expand/collapse the dropdown.