Added FXIOS-10710 default browser telemetry #23426

OrlaM · 2024-11-26T21:54:12Z

📜 Tickets

Jira ticket
Github issue

💡 Description

Marking as do not merge for now as this cannot be merged until Apple release the RC of 18.2.

📝 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)

mergify · 2024-11-26T21:54:51Z

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

firefox-ios/firefox-ios-tests/Tests/ClientTests/Application/DefaultBrowserUitTests.swift

Cramsden

One question about test class name but looks good to me!

mergify · 2024-11-28T21:26:49Z

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

nbhasin2 · 2024-12-03T00:12:29Z

@OrlaM considering we are in v133.1 dot release phase, should this be going into v133.1 or next week for v133.2

mergify · 2024-12-03T10:17:41Z

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

This reverts commit 2e03e5a.

mobiletest-ci-bot · 2024-12-06T19:31:55Z

	Messages
📖	Project coverage: 33.05%
📖	Edited 12 files
📖	Created 6 files

Client.app: Coverage: 31.75

File	Coverage
DefaultBrowserUtil.swift	100.0%	✅
AppLaunchUtil.swift	0.0%	⚠️
TelemetryWrapper.swift	67.8%	✅
LocaleInterface.swift	0.0%	⚠️

libStorage.a: Coverage: 56.44

File	Coverage
RustFirefoxSuggest.swift	0.0%	⚠️

Generated by 🚫 Danger Swift against b732196

OrlaM · 2024-12-06T19:51:15Z

@Mergifyio backport release/v133 release/v134

mergify · 2024-12-06T19:51:19Z

backport release/v133 release/v134

✅ Backports have been created

#23616 Added FXIOS-10710 default browser telemetry (backport #23426) has been created for branch release/v133 but encountered conflicts
#23617 Added FXIOS-10710 default browser telemetry (backport #23426) has been created for branch release/v134 but encountered conflicts

clarmso

I will update test scripts to Xcode 18.2 in a separate PR. Let me approve this for now.

* Add default browser utility * Add telemetry * Telemetry tests * Add tests * Fix tests * Update bitrise to use 18.2 * Fix linting * Fix typo * Disable warnings as errors * Up the number of warnings * Revert "Update bitrise to use 18.2" This reverts commit 2e03e5a. * Update bitrise * Fix bitrise * Fix bitrise * Fix concurrency errors * Update api * Update sim versions * Fix test (cherry picked from commit 475c70f) # Conflicts: # bitrise.yml # firefox-ios/Client.xcodeproj/project.pbxproj # firefox-ios/Client.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

* Add default browser utility * Add telemetry * Telemetry tests * Add tests * Fix tests * Update bitrise to use 18.2 * Fix linting * Fix typo * Disable warnings as errors * Up the number of warnings * Revert "Update bitrise to use 18.2" This reverts commit 2e03e5a. * Update bitrise * Fix bitrise * Fix bitrise * Fix concurrency errors * Update api * Update sim versions * Fix test (cherry picked from commit 475c70f) # Conflicts: # firefox-ios/Client.xcodeproj/project.pbxproj # firefox-ios/Client.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

* Added FXIOS-10710 default browser telemetry (#23426) * Add default browser utility * Add telemetry * Telemetry tests * Add tests * Fix tests * Update bitrise to use 18.2 * Fix linting * Fix typo * Disable warnings as errors * Up the number of warnings * Revert "Update bitrise to use 18.2" This reverts commit 2e03e5a. * Update bitrise * Fix bitrise * Fix bitrise * Fix concurrency errors * Update api * Update sim versions * Fix test (cherry picked from commit 475c70f) # Conflicts: # bitrise.yml # firefox-ios/Client.xcodeproj/project.pbxproj # firefox-ios/Client.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved * Update Package.resolved * Update bitrise.yml * Fix conflicts --------- Co-authored-by: OrlaM <omitchell@mozilla.com>

* Added FXIOS-10710 default browser telemetry (#23426) * Add default browser utility * Add telemetry * Telemetry tests * Add tests * Fix tests * Update bitrise to use 18.2 * Fix linting * Fix typo * Disable warnings as errors * Up the number of warnings * Revert "Update bitrise to use 18.2" This reverts commit 2e03e5a. * Update bitrise * Fix bitrise * Fix bitrise * Fix concurrency errors * Update api * Update sim versions * Fix test (cherry picked from commit 475c70f) # Conflicts: # firefox-ios/Client.xcodeproj/project.pbxproj # firefox-ios/Client.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved * Update Package.resolved * fix conflicts --------- Co-authored-by: OrlaM <omitchell@mozilla.com>

adudenamedruby · 2024-12-11T19:52:11Z

We need a data review for this PR, friends, as it's adding telemetry, unless that has already happened.

lmarceau · 2024-12-11T19:55:34Z

firefox-ios/Client/metrics.yaml

+      - https://github.com/mozilla-mobile/firefox-ios/issues/XXX
+    data_reviews:
+      - https://github.com/mozilla-mobile/firefox-ios/pull/XXX
+    notification_emails:
+      - fx-ios-data-stewards@mozilla.com
+    expires: "2026-01-01"
+  choice_screen_acquisition:
+    type: boolean
+    description: |
+      The user installed the app via the browser choice screen
+    bugs:
+      - https://github.com/mozilla-mobile/firefox-ios/issues/XXX
+    data_reviews:
+      - https://github.com/mozilla-mobile/firefox-ios/pull/XXX


👀 Adding on Roux's comment, it seems the links in here miss some info

adudenamedruby · 2025-01-23T14:39:02Z

Heya; still looking for a data review for this PR.

OrlaM · 2025-01-29T17:51:28Z

@adudenamedruby

Request for data collection review form

What questions will you answer with this data?

This will be used to measure if a user is already set to default on first run. The assumption being that if they are already set to default and that they are in the EU then they have likely come from the browser choice screen.

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 will allow us to measure how important set to default is for new users with regards to user retention.

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 #
If the app is set to default	Category 1	https://mozilla-hub.atlassian.net/browse/DMA-264
If the user has come from a browser choice screen	Category 1	https://mozilla-hub.atlassian.net/browse/DMA-264

Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.

https://dictionary.telemetry.mozilla.org/apps/firefox_ios

How long will this data be collected? Choose one of the following:

Forever, it will be used as a core business metric

What populations will you measure?

Which release channels?

All

Which countries?

All

Which locales?

All

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.

Glean

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

The iOS team

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

adudenamedruby · 2025-01-29T18:17:23Z

r+

Data Review Form

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, telemetry is documented at https://dictionary.telemetry.mozilla.org/apps/firefox_ios

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

Yes, Firefox iOS provides data controls in the app settings

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

This will be reviewed by a data-steward on the Firefox iOS team (@adudenamedruby) every 6 months

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

Cat 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 the data collection use a third-party collection tool?

No

OrlaM added the Do Not Merge ⛔️ This issue is a work in progress and is not ready to land label Nov 26, 2024

OrlaM requested review from a team as code owners November 26, 2024 21:54

OrlaM requested a review from isabelrios November 26, 2024 21:54

OrlaM force-pushed the om/FXIOS-10710-default-browser-telemetry branch from 5b55f44 to da2f042 Compare November 26, 2024 21:55

OrlaM had a problem deploying to github-pages November 26, 2024 21:55 — with GitHub Actions Failure

OrlaM requested review from clarmso and Cramsden and removed request for isabelrios November 26, 2024 21:57

Cramsden reviewed Nov 27, 2024

View reviewed changes

firefox-ios/firefox-ios-tests/Tests/ClientTests/Application/DefaultBrowserUitTests.swift Outdated Show resolved Hide resolved

Cramsden approved these changes Nov 27, 2024

View reviewed changes

OrlaM force-pushed the om/FXIOS-10710-default-browser-telemetry branch from da2f042 to 8fe0f21 Compare November 28, 2024 14:47

OrlaM closed this Nov 28, 2024

OrlaM reopened this Nov 28, 2024

OrlaM force-pushed the om/FXIOS-10710-default-browser-telemetry branch from f70bd33 to 4908dfe Compare December 2, 2024 16:23

OrlaM added 11 commits December 6, 2024 13:22

Add default browser utility

d1d4a2c

Add telemetry

a6058f2

Telemetry tests

8a8c84d

Add tests

71e0785

Fix tests

b04b863

Update bitrise to use 18.2

550fb29

Fix linting

04bfca4

Fix typo

7ea99b2

Disable warnings as errors

afb3d6f

Up the number of warnings

d06ec37

Revert "Update bitrise to use 18.2"

30f1b6b

This reverts commit 2e03e5a.

OrlaM added 5 commits December 6, 2024 13:23

Update bitrise

5340237

Fix bitrise

57498a5

Fix bitrise

66b5442

Fix concurrency errors

caf22eb

Update api

8b69ba5

OrlaM force-pushed the om/FXIOS-10710-default-browser-telemetry branch from 350d293 to 8b69ba5 Compare December 6, 2024 18:25

OrlaM added 2 commits December 6, 2024 13:49

Update sim versions

4201fd1

Fix test

b732196

clarmso approved these changes Dec 6, 2024

View reviewed changes

OrlaM merged commit 475c70f into main Dec 6, 2024
12 of 13 checks passed

OrlaM deleted the om/FXIOS-10710-default-browser-telemetry branch December 6, 2024 20:05

mergify bot mentioned this pull request Dec 6, 2024

Added FXIOS-10710 default browser telemetry (backport #23426) #23616

Merged

6 tasks

mergify bot mentioned this pull request Dec 6, 2024

Added FXIOS-10710 default browser telemetry (backport #23426) #23617

Merged

6 tasks

lmarceau reviewed Dec 11, 2024

View reviewed changes

OrlaM removed the Do Not Merge ⛔️ This issue is a work in progress and is not ready to land label Dec 11, 2024

OrlaM mentioned this pull request Jan 29, 2025

Bugfix FXIOS-10710 Add missing links to metrics yml #24430

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added FXIOS-10710 default browser telemetry #23426

Added FXIOS-10710 default browser telemetry #23426

OrlaM commented Nov 26, 2024 •

edited

Loading

mergify bot commented Nov 26, 2024

Cramsden left a comment

mergify bot commented Nov 28, 2024

nbhasin2 commented Dec 3, 2024

mergify bot commented Dec 3, 2024

mobiletest-ci-bot commented Dec 6, 2024

OrlaM commented Dec 6, 2024

mergify bot commented Dec 6, 2024 •

edited

Loading

clarmso left a comment

adudenamedruby commented Dec 11, 2024

lmarceau Dec 11, 2024

adudenamedruby commented Jan 23, 2025

OrlaM commented Jan 29, 2025

adudenamedruby commented Jan 29, 2025

Added FXIOS-10710 default browser telemetry #23426

Added FXIOS-10710 default browser telemetry #23426

Conversation

OrlaM commented Nov 26, 2024 • edited Loading

📜 Tickets

💡 Description

📝 Checklist

mergify bot commented Nov 26, 2024

Cramsden left a comment

Choose a reason for hiding this comment

mergify bot commented Nov 28, 2024

nbhasin2 commented Dec 3, 2024

mergify bot commented Dec 3, 2024

mobiletest-ci-bot commented Dec 6, 2024

Client.app: Coverage: 31.75

libStorage.a: Coverage: 56.44

OrlaM commented Dec 6, 2024

mergify bot commented Dec 6, 2024 • edited Loading

✅ Backports have been created

clarmso left a comment

Choose a reason for hiding this comment

adudenamedruby commented Dec 11, 2024

lmarceau Dec 11, 2024

Choose a reason for hiding this comment

adudenamedruby commented Jan 23, 2025

OrlaM commented Jan 29, 2025

Request for data collection review form

adudenamedruby commented Jan 29, 2025

Data Review Form

OrlaM commented Nov 26, 2024 •

edited

Loading

mergify bot commented Dec 6, 2024 •

edited

Loading