For #4421: Add search widget attribute to Leanplum

[jyeontaek]

Pull Request checklist

• Quality: This PR builds and passes detekt/ktlint checks (A pre-push hook is recommended)
• Tests: This PR includes thorough tests or an explanation of why it does not
• Changelog: This PR includes a changelog entry or does not need one
• Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

[jyeontaek]

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 users are installing the search widget

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?

• To measure how engaged users are with the search widget

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

• N/A (These are baseline metrics)

4. Can current instrumentation answer these questions?

• No, while we are tracking some of these metrics in Glean, we need access to them in Leanplum for marketing usage.

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 1.

6. How long will this data be collected?

• Until 04/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.

• Leanplum / Amplitude

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

• Only on Leanplum, Amplitude and with mobile teams.

[codecov-io]

Codecov Report

Merging #4694 into master will decrease coverage by 0.03%.
The diff coverage is 0%.

@@             Coverage Diff             @@
##             master   #4694      +/-   ##
===========================================
- Coverage      6.43%    6.4%   -0.04%     
  Complexity      154     154              
===========================================
  Files           205     205              
  Lines          8969    8983      +14     
  Branches       1320    1321       +1     
===========================================
- Hits            577     575       -2     
- Misses         8353    8369      +16     
  Partials         39      39

Impacted Files	Coverage Δ	Complexity Δ
.../src/main/java/org/mozilla/fenix/utils/Settings.kt	75.18% <0%> (-4.82%)	40 <0> (ø)
...fenix/components/metrics/LeanplumMetricsService.kt	0% <0%> (ø)	0 <0> (ø)	⬇️
...ain/java/org/mozilla/fenix/SearchWidgetProvider.kt	1.85% <0%> (-0.08%)	1 <0> (ø)
app/src/main/java/org/mozilla/fenix/ext/Context.kt	12% <0%> (-8%)	0% <0%> (ø)
...ug/java/org/mozilla/fenix/DebugFenixApplication.kt	0% <0%> (ø)	0% <0%> (ø)	⬇️

---

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 f5ffe37...6fd736e. Read the comment docs.

[boek]

Hey @jyeontaek could you add this items to the docs in this file https://github.com/mozilla-mobile/fenix/blob/master/docs/mma.md#user-attributes

Another question: Do we want to add this to the glean core ping as well?

[boek]

Add documentation to mma.md

[jyeontaek]

@boek Added documentation: #4713

Edit: Sorry, I'll add the documentation in this PR.

[boek]

Data Review Form (to be filled by Data Stewards)

Instructions: Data Stewards will review a request for data collection and endorse responses to each question.

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, with mma.md

2. Is there a control mechanism that allows the user to turn the data collection on and off?
   Yes, in the Fenix settings

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

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

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 there need to be a check-in in the future to determine whether to renew the data?
   Has expiry. Fenix team will monitor

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