For #9488: Add Search widget CFR & telemetry

[sblatz]

Demo

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?

• How often are users shown the CFR for search widget?
• How do users interact with the CFR for search widget (dismiss, cancel, add widget)?
• Are users who are given the CFR for search widget more likely to install it?

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?

• These are being used for a bigger experiment around retention. Our goal is to see if using a search widget CFR can drive users to install a search widget, and ultimately retain better because of it.

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

• This CFR is new so we do not have any metrics to track it. The search_widget_installed value is now getting sent in the Glean metrics ping so we can access it through the experimentation framework (instead of just Leanplum).

4. Can current instrumentation answer these questions?

• N/A, this is a new feature.

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 #10958 into master will increase coverage by 0.03%.
The diff coverage is 21.73%.

@@             Coverage Diff              @@
##             master   #10958      +/-   ##
============================================
+ Coverage     19.40%   19.44%   +0.03%     
- Complexity      635      637       +2     
============================================
  Files           363      365       +2     
  Lines         15153    15245      +92     
  Branches       2044     2052       +8     
============================================
+ Hits           2941     2964      +23     
- Misses        11930    11998      +68     
- Partials        282      283       +1     

Impacted Files	Coverage Δ	Complexity Δ
...main/java/org/mozilla/fenix/cfr/SearchWidgetCFR.kt	0.00% <0.00%> (ø)	0.00 <0.00> (?)
...rg/mozilla/fenix/components/SearchWidgetCreator.kt	0.00% <0.00%> (ø)	0.00 <0.00> (?)
...va/org/mozilla/fenix/components/metrics/Metrics.kt	19.39% <0.00%> (-0.24%)	0.00 <0.00> (ø)
...c/main/java/org/mozilla/fenix/home/HomeFragment.kt	0.00% <0.00%> (ø)	0.00 <0.00> (ø)
...la/fenix/components/metrics/GleanMetricsService.kt	8.69% <11.11%> (+0.06%)	3.00 <0.00> (ø)
.../src/main/java/org/mozilla/fenix/utils/Settings.kt	70.79% <53.33%> (-0.68%)	33.00 <1.00> (+2.00)	⬇️
...pp/src/main/java/org/mozilla/fenix/FeatureFlags.kt	100.00% <100.00%> (ø)	2.00 <0.00> (ø)
.../java/org/mozilla/fenix/search/SearchController.kt	75.00% <100.00%> (+0.67%)	0.00 <0.00> (ø)
... and 1 more

---

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 63b4fcd...ee19f3b. Read the comment docs.

[liuche]

Data-review+ only

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, this is documented in metrics.md

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

Yes, this is controlled by Fenix data collection setting

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

This has expiry, 9/1/2020

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

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

default on for Fenix

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, this is usage interaction data

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?

Has an expiry

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

[ekager]

r+ with nits

[ekager]

The description says this is a placeholder string so do we want to sub out "Firefox" for a placeholder?

[sblatz]

Good question. I'm actually not sure and forgot to put a "TODO" on this. I think I need an answer from @brampitoyo on whether or not this string should always say "Firefox" or not.

[sblatz]

Got a thumbs up from Betsy that we can go ahead with just "firefox"

[liuche]

Note here about running this experiment - this is going to hit up against some of our other experimentation, so it may delay our EOL of the various Nightly channels, since it needs 3 weeks to run. Our next release is 5.2 and will go out next week.