For #11118: Add toggle states to metrics ping

[sblatz]

Pull Request checklist

• Tests: This PR includes thorough tests or an explanation of why it does not
• Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not
• Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features. In addition, it includes a screenshot of a successful accessibility scan to ensure no new defects are added to the product.

After merge

• Milestone: Make sure issues finished by this pull request are added to the milestone of the version currently in development.

To download an APK when reviewing a PR:

1. click on Show All Checks,
2. click Details next to "Taskcluster (pull_request)" after it appears and then finishes with a green checkmark,
3. click on the "Fenix - assemble" task, then click "Run Artifacts".
4. the APK links should be on the left side of the screen, named for each CPU architecture

[sblatz]

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 settings preferences do users have?
• What % of our users have show_search_suggestions enabled?
• What % of our users have remote_debugging enabled?
• What % of our users have telemetry enabled?
• What % of our users have tracking_protection enabled?
• What % of our users have search_bookmarks enabled?
• What % of our users have search_browsing_history enabled?
• What % of our users have search_clipboard_suggestion enabled?
• What % of our users have search_shortcuts enabled?
• What % of our users have open_links_in_private_tab enabled?
• What % of our users have signed into FxA?
• What % of our users sync certain items via FxA?
• What % of our users have voice_search enabled?
• What % of our users have search_suggestions_private enabled?
• What % of our users have top vs. bottom toolbar?
• What % of our users have accessibility_services enabled?

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?

• It is crucial we know what types of user segments we have so we can prioritize certain features. It is also important for helping us drive decisions around resourcing. This data will help us better slice our user population & figure out retention metrics.

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?

• We currently have preferenceToggled events for most of these. Unfortunately these queries are incredibly expensive to run and can often be error prone. Because of this, we are approaching it with a simpler metrics ping.

4. Can current instrumentation answer these questions?

• No, see above.

5. List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox data collection categories on the found on the Mozilla wiki.

• All data is Category 2.

6. How long will this data be collected?

• Until 09/01/2020

7. What populations will you measure?

• All release, beta, and nightly users with telemetry enabled.

8. Please provide a general description of how you will analyze this data.

• Glean / Amplitude

9. Where do you intend to share the results of your analysis?

• Only on Glean, Amplitude and with mobile teams.

[codecov-commenter]

Codecov Report

Merging #11211 into master will increase coverage by 0.05%.
The diff coverage is 63.88%.

@@             Coverage Diff              @@
##             master   #11211      +/-   ##
============================================
+ Coverage     20.49%   20.55%   +0.05%     
  Complexity      680      680              
============================================
  Files           372      372              
  Lines         15415    15478      +63     
  Branches       2075     2090      +15     
============================================
+ Hits           3160     3182      +22     
- Misses        11958    11994      +36     
- Partials        297      302       +5     

Impacted Files	Coverage Δ	Complexity Δ
...la/fenix/components/metrics/GleanMetricsService.kt	12.96% <60.60%> (+4.27%)	3.00 <1.00> (ø)
.../src/main/java/org/mozilla/fenix/utils/Settings.kt	68.60% <100.00%> (+0.25%)	33.00 <0.00> (ø)
...ozilla/fenix/collections/CollectionCreationView.kt	34.61% <0.00%> (-1.00%)	6.00% <0.00%> (ø%)
...a/org/mozilla/gecko/search/SearchWidgetProvider.kt	1.35% <0.00%> (-0.88%)	1.00% <0.00%> (ø%)
...nix/collections/CollectionCreationBottomBarView.kt	97.50% <0.00%> (ø)	8.00% <0.00%> (ø%)
...ix/home/sessioncontrol/SessionControlController.kt	70.79% <0.00%> (+0.88%)	0.00% <0.00%> (ø%)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9272026...8b44b5c. Read the comment docs.

[liuche]

data + code review r+wn

glad these are going to be collected in metrics ping rather than events!

Data Review Form (to be filled by Data Stewards)

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, updates metrics.md

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

Yes, telemetry settings in Fenix

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

Expires

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

Type 2, settings

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, app settings and accessibility settings

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

yes

8. Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No) (If yes, set a todo reminder or file a bug if appropriate)**

No, has expiry

9. Does the data collection use a third-party collection tool? If yes, escalate to legal.

no

[liuche]

Oh, so did we not have this before?

It's a little weird that this isn't a radio preference...in theory does that mean that the settings could get messed up and more than one of these could be selected? 🤔 (out of scope for this bug I know)

[sblatz]

Let me touch base with Emily about this. I think the Radio Group does prevent these from getting sent to multiple true vales.

[ekager]

Yeah you could just use this logic without adding the new setting https://github.com/mozilla-mobile/fenix/blob/master/app/src/main/java/org/mozilla/fenix/components/TrackingProtectionPolicyFactory.kt#L30-L33

[liuche]

thank goodness for glean 🙏 and not having to write this manually