Fix #6846 - Added event to track start search button press

[nbhasin2]

No description provided.

[travis79]

This looks good to me!

[mozillamobilebot]

SwiftLint found issues

Warnings

File	Line	Reason
UnifiedTelemetry.swift	257	Prefer empty collection over optional collection. (discouraged_optional_collection)
UnifiedTelemetry.swift	261	Prefer empty collection over optional collection. (discouraged_optional_collection)

Generated by 🚫 Danger

[nbhasin2]

Tagging @chutten for data review

[travis79]

Tagging @chutten for data review

Please fill out the required form from here before requesting review from a data steward. For an example of what a filled data review request should look like, see here: https://bugzilla.mozilla.org/show_bug.cgi?id=1635427 or here: mozilla-lockwise/lockwise-android#1196 (comment)

[nbhasin2]

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?
   Number of times user taps on the newly added search button (magnifying glass) at the bottom of the view.

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? Some example responses:

This in turn should increase the searches performed by the user as tapping the button takes user to the addressbar which is where user starts a search or goes to another website.

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

This is a new button and we don't have any metrics for it to measure.

4. Can current instrumentation answer these questions?

Not really as this button is just added so current instrumentation cannot determine the number of times user taps on the button. One could say we can tap into search analytics but then again it doesn't tie with the new button thats added right now.

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 #
Legacy telemetry start search button tap	Category 2	https://github.com//issues/6846

6. Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
   N/A in the old doc but adding link to the telemetry which I updated here in this PR

https://github.com/mozilla-mobile/firefox-ios/blob/bb38e861f68978e463176f6390ba26c30d825173/Docs/telemetry.md

7. How long will this data be collected? Choose one of the following:
   For the lifetime of the Firefox iOS application or until we have the new start search button in the app.

8. What populations will you measure?

All users

9. If this data collection is default on, what is the opt-out mechanism for users?

In Firefox iOS there is a preference for telemetry labeled "Send Usage Data" that will be used as the opt-out mechanism.

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

We will look at how many times user taps on the new start search button and b/w v27 to upcoming v28 if we see increase in search traffic.

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

Mozilla internal channels with our PM

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

No 3rd party tool

[nbhasin2]

@travis79 Could I request review on the above form and see if I am missing anything

[travis79]

@nbhasin2 Looks good on everything but two items:

• Item 6, can you add a line to /docs/telemetry.md and link to that doc here? That should satisfy this requirement
• Item 7, permanent collections require an individual contributor email as a metric owner so could you provide that info for whoever will take responsibility for this metric. For time limited collections, a team email is sufficient, you could say this will be collected for 6 months if that is appropriate.

[nbhasin2]

Hi @chutten @travis79 - I have added the data request form. Let me know if I missed anything and if I can get a review on it.

Thanks

[chutten]

PRELIMINARY NOTES

There is no individual listed as responsible for this collection. Collections that do not automatically expire require an individual responsible for them. I will assume @nbhasin2 is responsible.

DATA COLLECTION REVIEW RESPONSE:

Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes. https://github.com/mozilla-mobile/firefox-ios/blob/bb38e861f68978e463176f6390ba26c30d825173/Docs/telemetry.md

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

Yes. This collection is can be controlled through Firefox's Preferences.

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

Yes, @nbhasin2 is responsible.

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.

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

Default on for all channels.

Does the instrumentation include the addition of any new identifiers?

No.

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

Yes.

Does there need to be a check-in in the future to determine whether to renew the data?

No. This collection is permanent.

---

Result: datareview+

[nbhasin2]

Will take responsibility for this @chutten, thank you :)

[nbhasin2]

Tagging @garvankeeley for final code review