Skip to content
This repository has been archived by the owner on Jan 12, 2023. It is now read-only.

For #5519: Add telemetry for theme settings. #5526

Merged
merged 1 commit into from
Oct 13, 2021
Merged

For #5519: Add telemetry for theme settings. #5526

merged 1 commit into from
Oct 13, 2021

Conversation

mcarare
Copy link
Contributor

@mcarare mcarare commented Oct 1, 2021

No description provided.

@mcarare mcarare changed the title For #5518: Add telemetry for theme settings. For #5519: Add telemetry for theme settings. Oct 1, 2021
@mcarare mcarare added the needs:data-review PR is awaiting a data review label Oct 1, 2021
@mcarare mcarare requested a review from travis79 October 6, 2021 07:47
@mcarare
Copy link
Contributor Author

mcarare commented Oct 6, 2021

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

1) What questions will you answer with this data?
What theme setting do users prefer.

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?
This adds important info needed in order to better prioritize feature optimizations.

3) What alternative methods did you consider to answer these questions? Why were they not sufficient?
This is the only way.

4) Can current instrumentation answer these questions?
No. We need a new specific event for a specific app feature.

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.

Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.

Measurement Description Data Collection Category Tracking Bug #
Theme set by user Category 2 https://github.com//issues/5519

6) How long will this data be collected? Choose one of the following:
Expiry for capturing data is set to "2022-10-01"

7) What populations will you measure?
All release channels and locales.

8) If this data collection is default on, what is the opt-out mechanism for users?
Users can opt of of data collection by disabling Usage and technical data from Settings -> Privacy and security -> Data choices.

9) Please provide a general description of how you will analyze this data.
Glean

10) Where do you intend to share the results of your analysis?
Only on Glean, mobile teams and BD have internal access.

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

@travis79
Copy link
Member

travis79 commented Oct 6, 2021

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

1) What questions will you answer with this data? What theme setting do users prefer.

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? This adds important info needed in order to better prioritize feature optimizations.

3) What alternative methods did you consider to answer these questions? Why were they not sufficient? This is the only way.

4) Can current instrumentation answer these questions? No. We need a new specific event for a specific app feature.

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.

Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.
Measurement Description Data Collection Category Tracking Bug #
Theme set by user Category 2 https://github.com/[/issues/5519](https://github.com/mozilla-mobile/focus-android/issues/5519)

6) How long will this data be collected? Choose one of the following: Expiry for capturing data is set to "2022-10-01"

7) What populations will you measure? All release channels and locales.

8) If this data collection is default on, what is the opt-out mechanism for users? Users can opt of of data collection by disabling Usage and technical data from Settings -> Privacy and security -> Data choices.

9) Please provide a general description of how you will analyze this data. Glean

10) Where do you intend to share the results of your analysis? Only on Glean, mobile teams and BD have internal access.

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

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 and the Glean Dictionary

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

Yes, through the "Send Usage Data" preference in the application settings.

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

N/A, the collection is set to end or be renewed by 2022-10-01

  1. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 2, User interaction

  1. Is the data collection request for default-on or default-off?

default-on

  1. Does the instrumentation include the addition of any new identifiers?

No

  1. Is the data collection covered by the existing Firefox privacy notice?

Yes

  1. Does the data collection use a third-party collection tool?

No

Result

data-review+

@mcarare mcarare removed the needs:data-review PR is awaiting a data review label Oct 7, 2021
@mcarare mcarare marked this pull request as ready for review October 7, 2021 10:20
@mcarare mcarare added the 🕵️‍♀️ needs review PRs that need to be reviewed label Oct 7, 2021
// theme telemetry
val currentTheme =
when {
settings.lightThemeSelected -> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this PR: I never understood in Fenix why we have separate prefs for a radio group. Why one one pref with three values?

It completely skipped my mind to comment on this in the light mode PR when it was in review. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because radio preferences do not really exist. The only grouping made in native preferences is in list preferences. So we have to use checkbox preferences and add the grouping in our code.

@jonalmeida jonalmeida removed the 🕵️‍♀️ needs review PRs that need to be reviewed label Oct 13, 2021
@mcarare mcarare added the 🛬 needs landing PRs that are ready to land label Oct 13, 2021
@mergify mergify bot merged commit ec65103 into mozilla-mobile:main Oct 13, 2021
// theme telemetry
val currentTheme =
when {
settings.lightThemeSelected -> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mcarare Hey I am doing the same for iOS and I noticed that in metrics.yaml these are all in uppercase FOLLOW DEVICE, LIGHT, DARK while you set them here with mixed case. I will follow the code for consistency.

@travis79 Glean will not uppercase these strings right? They will appear in the database like they are spelled out in the code here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct. Glean will not modify the recorded strings, they will maintain the same case as they were recorded with.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🛬 needs landing PRs that are ready to land
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants