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

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

@@ -4,6 +4,7 @@
 
 import Common
 import Foundation
+import Glean
 import Shared
 
 enum SendDataType {
@@ -80,6 +81,16 @@ class SendDataSetting: BoolSetting {
         self.settingDidChange = { [weak self] value in
             // AdjustHelper.setEnabled($0)
             DefaultGleanWrapper.shared.setUpload(isEnabled: value)
+
+            if !value {
+                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") {
+                    GleanMetrics.Usage.profileId.set(uuid)
+                }
+            }
+
             Experiments.setTelemetrySetting(value)
             self?.shouldSendData?(value)
         }

firefox-ios/Client/Telemetry/TelemetryWrapper.swift

@@ -100,10 +100,25 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable {
         GleanMetrics.Search.defaultEngine.set(defaultEngine?.engineID ?? "unavailable")
 
         // Get the legacy telemetry ID and record it in Glean for the deletion-request ping
-        if let uuidString = UserDefaults.standard.string(forKey: "telemetry-key-prefix-clientId"), let uuid = UUID(uuidString: uuidString) {
+        if let uuidString = UserDefaults.standard.string(forKey: "telemetry-key-prefix-clientId"),
+           let uuid = UUID(uuidString: uuidString) {
             GleanMetrics.LegacyIds.clientId.set(uuid)
         }
 
+        // Set or generate profile id used for usage reporting
+        if profile.prefs.boolForKey(AppConstants.prefSendUsageData) ?? true {
+            if let uuidString = profile.prefs.stringForKey(PrefsKeys.Usage.profileId),
+                let uuid = UUID(uuidString: uuidString) {
+                GleanMetrics.Usage.profileId.set(uuid)
+            } else {
+                let uuid = GleanMetrics.Usage.profileId.generateAndSet()
+                profile.prefs.setString(uuid.uuidString, forKey: PrefsKeys.Usage.profileId)
+            }
+        } else if let uuid = UUID(uuidString: "beefbeef-beef-beef-beef-beeefbeefbee") {
+            // set dummy uuid to make sure the previous one is deleted
+            GleanMetrics.Usage.profileId.set(uuid)
+        }
+
         glean.registerPings(GleanMetrics.Pings.shared)
 
         // Initialize Glean telemetry

firefox-ios/Client/metrics.yaml

@@ -709,6 +709,28 @@ app:
       - [email protected]
     expires: "2025-01-01"
 
+# Usage reporting
+usage:
+  profile_id:
+    type: uuid
+    lifetime: user
+    description: |
+      A UUID uniquely identifying the profile,
+      not shared with other telemetry data.
+    bugs:
+      - https://github.com/mozilla-mobile/firefox-ios/pull/23254
+    data_reviews:
+      - https://github.com/mozilla-mobile/firefox-ios/pull/23254
+    data_sensitivity:
+      - technical
+      - highly_sensitive
+    notification_emails:
+      - [email protected]
+      - [email protected]
+    expires: never
+    send_in_pings:
+      - usage-reporting
+
 # Downloads
 downloads:
   download_now_button_tapped:

firefox-ios/Shared/Prefs.swift

@@ -194,6 +194,10 @@ public struct PrefsKeys {
 
     // Represents whether or not the user has seen the photon main menu once, at least.
     public static let PhotonMainMenuShown = "PhotonMainMenuShown"
+
+    public struct Usage {
+        public static let profileId = "profileId"
+    }
 }
 
 public protocol Prefs {