Add FXIOS-10617 [ToS] Add Glean usage profile id #23254

thatswinnie · 2024-11-20T13:19:24Z

📜 Tickets

Jira ticket
Github issue

💡 Description

Adds the Glean usage profile id.

📝 Checklist

You have to check all boxes before merging

Filled in the above information (tickets numbers and description of your work)
Updated the PR name to follow our PR naming guidelines
Wrote unit tests and/or ensured the tests suite is passing
When working on UI, I checked and implemented accessibility (minimum Dynamic Text and VoiceOver)
If needed, I updated documentation / comments for complex code and public methods
If needed, added a backport comment (example @Mergifyio backport release/v120)

mobiletest-ci-bot · 2024-11-20T16:21:27Z

	Messages
📖	Project coverage: 32.94%
📖	Edited 4 files
📖	Created 0 files

Client.app: Coverage: 31.64

File	Coverage
SendDataSetting.swift	63.3%	✅
TelemetryWrapper.swift	67.7%	✅

Generated by 🚫 Danger Swift against 5ab7ffc

…lean-usage-profile-id

badboy

Couple of things inline.

I don't know the Focus iOS codebase, but can I assume the implementation there would look similar then?

firefox-ios/Client/metrics.yaml

firefox-ios/Client/Frontend/Settings/Main/Support/SendAnonymousUsageDataSetting.swift

firefox-ios/Client/Telemetry/TelemetryWrapper.swift

Co-authored-by: Jan-Erik Rediger <[email protected]>

…sUsageDataSetting.swift Co-authored-by: Jan-Erik Rediger <[email protected]>

thatswinnie · 2024-11-26T10:13:37Z

I don't know the Focus iOS codebase, but can I assume the implementation there would look similar then?

Yes, it should look similar (I am not super familiar with the Focus code either). The dev that will handle Focus is back next week and will open a PR.

mergify · 2024-11-26T10:17:48Z

This pull request has conflicts when rebasing. Could you fix it @thatswinnie? 🙏

…lean-usage-profile-id

thatswinnie · 2024-11-26T11:12:46Z

@adudenamedruby @travis79

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.

What questions will you answer with this data?
It will give us the ability to count profiles.
Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements?
Understand usage of Firefox iOS. This change allows us to offer Firefox users more granular choices in data collection.
What alternative methods did you consider to answer these questions? Why were they not sufficient?
There are no other methods
Can current instrumentation answer these questions?
No.
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 #
usage.profile_id Records a UUID uniquely identifying the profile	1 + 4	#23407

Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
Firefox iOS Telemetry Dictionary
How long will this data be collected? Choose one of the following:
Set to never expire
What populations will you measure?

Which release channels? All
Which countries? All
Which locales? All
Any other filters? Please describe in detail below.

If this data collection is default on, what is the opt-out mechanism for users?
The user can opt out
Please provide a general description of how you will analyze this data.
The data will be analyzed using Glean.
Where do you intend to share the results of your analysis?
The results will be shared internally through Glean and with advertising partners.
Is there a third-party tool (i.e. not Glean or Telemetry) that you are proposing to use for this data collection? If so:
No third-party tools are proposed for this data collection.

travis79

@adudenamedruby @travis79

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?
   _It will give us the ability to count profiles._

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?
   _Understand usage of Firefox iOS. This change allows us to offer Firefox users more granular choices in data collection._

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?
   _There are no other methods_

4. Can current instrumentation answer these questions?
   _No._

5. List all proposed measurements and indicate the category of data collection for each measurement, using the [Firefox data collection categories](https://wiki.mozilla.org/Data_Collection) 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 #
usage.profile_id
Records a UUID uniquely identifying the profile 1 + 4 FXIOS-10617

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.
   [Firefox iOS Telemetry Dictionary](https://dictionary.telemetry.mozilla.org/apps/firefox_ios)

7. How long will this data be collected?  Choose one of the following:
   _Set to never expire_

8. What populations will you measure?


* Which release channels? _All_

* Which countries? _All_

* Which locales? _All_

* Any other filters?  Please describe in detail below.


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

10. Please provide a general description of how you will analyze this data.
    _The data will be analyzed using Glean._

11. Where do you intend to share the results of your analysis?
    _The results will be shared internally through Glean and with advertising partners._

12. Is there a third-party tool (i.e. not Glean or Telemetry) that you are proposing to use for this data collection? If so:
    _No third-party tools are proposed for this data collection._

This has been approved by Mozilla Trust & Legal, I'm providing the data-review+ here as covered by their review and approval.

badboy

one last nit, but then good to go!

firefox-ios/Client/Telemetry/TelemetryWrapper.swift

Co-authored-by: Jan-Erik Rediger <[email protected]>

adudenamedruby · 2024-11-27T14:20:15Z

firefox-ios/Client/Frontend/Settings/Main/Support/SendDataSetting.swift

+                self?.prefs?.removeObjectForKey(PrefsKeys.Usage.profileId)
+
+                // set dummy uuid to make sure the previous one is deleted
+                if let uuid = UUID(uuidString: "beefbeef-beef-beef-beef-beeefbeefbee") {


LOL amazing!

I didn't knew Winnie liked beef that much

c0ffee (and decaf) were already taken and I couldn't come up with other fun stuff.

LOL. I like beef and I cannot lie 😇
But seriously, that string actually came from @badboy

thatswinnie added 4 commits November 20, 2024 13:46

Add pref key

a6df939

Add usage metric

4c3a0e2

Set or generate profile id

bbf9033

Delete profile id when user turns off reporting

33f1fde

thatswinnie marked this pull request as ready for review November 20, 2024 16:22

thatswinnie requested a review from a team as a code owner November 20, 2024 16:22

thatswinnie requested review from MattLichtenstein and badboy November 20, 2024 16:22

Merge remote-tracking branch 'mozilla/main' into wt/FXIOS-10617-Add-G…

424f0e8

…lean-usage-profile-id

thatswinnie had a problem deploying to github-pages November 26, 2024 09:42 — with GitHub Actions Failure

badboy suggested changes Nov 26, 2024

View reviewed changes

thatswinnie and others added 6 commits November 26, 2024 10:58

Update firefox-ios/Client/metrics.yaml

b3832ef

Co-authored-by: Jan-Erik Rediger <[email protected]>

Update firefox-ios/Client/metrics.yaml

da4e2f2

Co-authored-by: Jan-Erik Rediger <[email protected]>

Update firefox-ios/Client/Frontend/Settings/Main/Support/SendAnonymou…

442ce32

…sUsageDataSetting.swift Co-authored-by: Jan-Erik Rediger <[email protected]>

Update metrics

ec45364

Fix build error

97daa50

Addressing PR comments

56da59e

Merge remote-tracking branch 'mozilla/main' into wt/FXIOS-10617-Add-G…

68913ec

…lean-usage-profile-id

thatswinnie had a problem deploying to github-pages November 26, 2024 10:25 — with GitHub Actions Failure

travis79 approved these changes Nov 26, 2024

View reviewed changes

badboy approved these changes Nov 26, 2024

View reviewed changes

firefox-ios/Client/Telemetry/TelemetryWrapper.swift Outdated Show resolved Hide resolved

Update firefox-ios/Client/Telemetry/TelemetryWrapper.swift

5ab7ffc

Co-authored-by: Jan-Erik Rediger <[email protected]>

MattLichtenstein approved these changes Nov 27, 2024

View reviewed changes

thatswinnie merged commit f0fc50b into main Nov 27, 2024
6 checks passed

thatswinnie deleted the wt/FXIOS-10617-Add-Glean-usage-profile-id branch November 27, 2024 14:17

adudenamedruby reviewed Nov 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add FXIOS-10617 [ToS] Add Glean usage profile id #23254

Add FXIOS-10617 [ToS] Add Glean usage profile id #23254

thatswinnie commented Nov 20, 2024 •

edited

Loading

mobiletest-ci-bot commented Nov 20, 2024 •

edited

Loading

badboy left a comment

thatswinnie commented Nov 26, 2024

mergify bot commented Nov 26, 2024

thatswinnie commented Nov 26, 2024 •

edited

Loading

travis79 left a comment

badboy left a comment

adudenamedruby Nov 27, 2024

lmarceau Nov 27, 2024

badboy Nov 27, 2024

thatswinnie Nov 27, 2024

Add FXIOS-10617 [ToS] Add Glean usage profile id #23254

Add FXIOS-10617 [ToS] Add Glean usage profile id #23254

Conversation

thatswinnie commented Nov 20, 2024 • edited Loading

📜 Tickets

💡 Description

📝 Checklist

mobiletest-ci-bot commented Nov 20, 2024 • edited Loading

Client.app: Coverage: 31.64

badboy left a comment

Choose a reason for hiding this comment

thatswinnie commented Nov 26, 2024

mergify bot commented Nov 26, 2024

thatswinnie commented Nov 26, 2024 • edited Loading

Request for data collection review form

travis79 left a comment

Choose a reason for hiding this comment

Request for data collection review form

badboy left a comment

Choose a reason for hiding this comment

adudenamedruby Nov 27, 2024

Choose a reason for hiding this comment

lmarceau Nov 27, 2024

Choose a reason for hiding this comment

badboy Nov 27, 2024

Choose a reason for hiding this comment

thatswinnie Nov 27, 2024

Choose a reason for hiding this comment

thatswinnie commented Nov 20, 2024 •

edited

Loading

mobiletest-ci-bot commented Nov 20, 2024 •

edited

Loading

thatswinnie commented Nov 26, 2024 •

edited

Loading