Add FXIOS-13934 Add iOS support for Nimbus advanced targeting for ToU experience points (#30428)

* Add FXIOS-13934 Add iOS support for Nimbus advanced targeting for ToU experience points

Author: rilury

firefox-ios/Client.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		032CE5F62EBA0C04007CCC0D /* ToUExperiencePointsCalculatorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 032CE5F52EBA0C04007CCC0D /* ToUExperiencePointsCalculatorTests.swift */; };
 		033A5FCC2E5F001200A84E8A /* TermsOfUseTelemetryTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 033A5FCB2E5F001200A84E8A /* TermsOfUseTelemetryTests.swift */; };
 		033A62002E77FE9900A84E8A /* ResetTermsOfServiceAcceptancePage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 033A61FF2E77FE9900A84E8A /* ResetTermsOfServiceAcceptancePage.swift */; };
 		033C94F72E2FBCDD00C2382F /* TermsOfUseMiddlewareTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 033C94F62E2FBCD300C2382F /* TermsOfUseMiddlewareTests.swift */; };
@@ -2546,6 +2547,7 @@
 		02C94BE0922C110AFF6944E3 /* bo */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = bo; path = bo.lproj/ClearPrivateDataConfirm.strings; sourceTree = "<group>"; };
 		02E547BF89DA742677E367E6 /* hi-IN */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = "hi-IN"; path = "hi-IN.lproj/InfoPlist.strings"; sourceTree = "<group>"; };
 		02FC4A06A948593BE97BC508 /* zh-TW */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = "zh-TW"; path = "zh-TW.lproj/LoginManager.strings"; sourceTree = "<group>"; };
+		032CE5F52EBA0C04007CCC0D /* ToUExperiencePointsCalculatorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ToUExperiencePointsCalculatorTests.swift; sourceTree = "<group>"; };
 		033A5FCB2E5F001200A84E8A /* TermsOfUseTelemetryTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TermsOfUseTelemetryTests.swift; sourceTree = "<group>"; };
 		033A61FF2E77FE9900A84E8A /* ResetTermsOfServiceAcceptancePage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ResetTermsOfServiceAcceptancePage.swift; sourceTree = "<group>"; };
 		033C94F62E2FBCD300C2382F /* TermsOfUseMiddlewareTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TermsOfUseMiddlewareTests.swift; sourceTree = "<group>"; };
@@ -11407,6 +11409,7 @@
 		033C94F32E2F839900C2382F /* TermsOfUse */ = {
 			isa = PBXGroup;
 			children = (
+				032CE5F52EBA0C04007CCC0D /* ToUExperiencePointsCalculatorTests.swift */,
 				033A5FCB2E5F001200A84E8A /* TermsOfUseTelemetryTests.swift */,
 				033C94F62E2FBCD300C2382F /* TermsOfUseMiddlewareTests.swift */,
 			);
@@ -19775,6 +19778,7 @@
 				E1463D042982D0240074E16E /* NotificationManagerTests.swift in Sources */,
 				8AA0A6682CAC747500AC7EB3 /* HomepageDiffableDataSourceTests.swift in Sources */,
 				C8E1BC0A28085AA700C62964 /* NimbusFeatureFlagLayerTests.swift in Sources */,
+				032CE5F62EBA0C04007CCC0D /* ToUExperiencePointsCalculatorTests.swift in Sources */,
 				F80D53CF2A09A3350047ED14 /* RustSyncManagerTests.swift in Sources */,
 				1D3C90882ACE1AF400304C87 /* RemoteTabPanelTests.swift in Sources */,
 				43446CF02412DDBE00F5C643 /* UpdateViewModelTests.swift in Sources */,

firefox-ios/Client/Experiments/Experiments.swift

@@ -207,6 +207,11 @@ enum Experiments {
         return prefsReader.hasAcceptedTermsOfUse()
     }
 
+    static func touExperiencePoints(region: String?) -> Int32 {
+        let prefsReader = ProfilePrefsReader()
+        return prefsReader.getTouExperiencePoints(region: region)
+    }
+
     private static func isAppleIntelligenceAvailable() -> Bool {
         guard #available(iOS 26, *) else { return false }
         #if canImport(FoundationModels)

firefox-ios/Client/Experiments/RecordedNimbusContext.swift

@@ -54,6 +54,7 @@ final class RecordedNimbusContext: RecordedContext, @unchecked Sendable {
     var locale: String
     var daysSinceInstall: Int32?
     var daysSinceUpdate: Int32?
+    var touExperiencePoints: Int32?
 
     private var eventQueries: [String: String]
     private var eventQueryValues: [String: Double] = [:]
@@ -113,6 +114,7 @@ final class RecordedNimbusContext: RecordedContext, @unchecked Sendable {
         daysSinceUpdate = calculatedAttributes.daysSinceUpdate
         language = calculatedAttributes.language
         region = calculatedAttributes.region
+        touExperiencePoints = Experiments.touExperiencePoints(region: region)
         self.logger.log("init end", level: .debug, category: .experiments)
     }
 
@@ -154,7 +156,8 @@ final class RecordedNimbusContext: RecordedContext, @unchecked Sendable {
                 hasEnabledTipsNotifications: hasEnabledTipsNotifications,
                 hasAcceptedTermsOfUse: hasAcceptedTermsOfUse,
                 isAppleIntelligenceAvailable: isAppleIntelligenceAvailable,
-                cannotUseAppleIntelligence: cannotUseAppleIntelligence
+                cannotUseAppleIntelligence: cannotUseAppleIntelligence,
+                touExperiencePoints: touExperiencePoints.toInt64()
             )
         )
         GleanMetrics.Pings.shared.nimbus.submit()
@@ -199,7 +202,8 @@ final class RecordedNimbusContext: RecordedContext, @unchecked Sendable {
             "has_enabled_tips_notifications": hasEnabledTipsNotifications,
             "has_accepted_terms_of_use": hasAcceptedTermsOfUse,
             "is_apple_intelligence_available": isAppleIntelligenceAvailable,
-            "cannot_use_apple_intelligence": cannotUseAppleIntelligence
+            "cannot_use_apple_intelligence": cannotUseAppleIntelligence,
+            "tou_experience_points": touExperiencePoints as Any
         ]),
             let jsonString = NSString(data: data, encoding: String.Encoding.utf8.rawValue) as? String
         else {

firefox-ios/Client/Frontend/Browser/TermsOfUse/ToUExperiencePointsCalculator.swift

@@ -0,0 +1,64 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import Common
+import Shared
+
+// Calculates ToU experience points (0-2) based on privacy settings
+// Used for Nimbus targeting: +1 for ETP Strict, +1 for disabling sponsored content
+struct ToUExperiencePointsCalculator {
+    private let userDefaults: UserDefaultsInterface
+    private let region: String?
+
+    // Countries that support sponsored content (determined by geolocation)
+    // Source: https://mozilla-hub.atlassian.net/browse/FXIOS-13934
+    private static let sponsoredContentSupportedCountries: Set<String> = [
+        "AT", "BE", "BG", "CA", "CH", "CY", "CZ", "DE", "DK", "EE",
+        "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IS", "JP",
+        "LT", "LV", "MT", "NL", "NO", "NZ", "PL", "PT", "RO", "SE",
+        "SG", "SK", "US"
+    ]
+
+    init(userDefaults: UserDefaultsInterface, region: String?) {
+        self.userDefaults = userDefaults
+        self.region = region
+    }
+
+    func calculatePoints() -> Int32 {
+        var points: Int32 = 0
+        if hasEnabledStrictTracking() {
+            points += 1
+        }
+        if hasDisabledSponsoredContent() {
+            points += 1
+        }
+        return points
+    }
+
+    private func hasEnabledStrictTracking() -> Bool {
+        let enabledKey = ProfilePrefsReader.prefix + ContentBlockingConfig.Prefs.EnabledKey
+        let strengthKey = ProfilePrefsReader.prefix + ContentBlockingConfig.Prefs.StrengthKey
+
+        guard userDefaults.bool(forKey: enabledKey) else { return false }
+        return userDefaults.string(forKey: strengthKey) == BlockingStrength.strict.rawValue
+    }
+
+    private func hasDisabledSponsoredContent() -> Bool {
+        // Only award points in countries where sponsored content is available
+        guard let region = region,
+              Self.sponsoredContentSupportedCountries.contains(region) else {
+            return false
+        }
+
+        let allShortcutsKey = ProfilePrefsReader.prefix + PrefsKeys.UserFeatureFlagPrefs.TopSiteSection
+        let sponsoredKey = ProfilePrefsReader.prefix + PrefsKeys.FeatureFlags.SponsoredShortcuts
+
+        let allShortcutsEnabled = userDefaults.object(forKey: allShortcutsKey) as? Bool ?? true
+        let sponsoredEnabled = userDefaults.object(forKey: sponsoredKey) as? Bool ?? true
+
+        // Award point if user disabled sponsored shortcuts specifically
+        // OR if they disabled all shortcuts
+        return !sponsoredEnabled || !allShortcutsEnabled
+    }
+}

firefox-ios/Client/Glean/probes/metrics.yaml

@@ -3588,6 +3588,8 @@ nimbus_system:
           type: boolean
         cannot_use_apple_intelligence:
           type: boolean
+        tou_experience_points:
+          type: number
     description: |
       The Nimbus context object that is recorded to Glean
     bugs:

firefox-ios/Client/ProfilePrefsReader.swift

@@ -59,4 +59,12 @@ struct ProfilePrefsReader {
 
         return hasAcceptedToU || hasAcceptedToS
     }
+
+    /// Delegates calculation to ToUExperiencePointsCalculator
+    /// Parameter region: The user's region code
+    /// Returns: The calculated  points (0, 1, or 2) based on user settings
+    func getTouExperiencePoints(region: String?) -> Int32 {
+        let calculator = ToUExperiencePointsCalculator(userDefaults: userDefaults, region: region)
+        return calculator.calculatePoints()
+    }
 }

firefox-ios/firefox-ios-tests/Tests/ClientTests/Nimbus/RecordedNimbusContextTests.swift

@@ -76,6 +76,10 @@ class RecordedNimbusContextTests: XCTestCase {
             json?.removeValue(forKey: "cannot_use_apple_intelligence") as? Bool,
             recordedContext.cannotUseAppleIntelligence
         )
+        XCTAssertEqual(
+            json?.removeValue(forKey: "tou_experience_points") as? Int32,
+            recordedContext.touExperiencePoints
+        )
 
         var events = json?.removeValue(forKey: "events") as? [String: Double]
         XCTAssertNotNil(events)
@@ -127,6 +131,10 @@ class RecordedNimbusContextTests: XCTestCase {
             value?.hasAcceptedTermsOfUse,
             recordedContext.hasAcceptedTermsOfUse
         )
+        XCTAssertEqual(
+            value?.touExperiencePoints,
+            recordedContext.touExperiencePoints.toInt64()
+        )
 
         XCTAssertNotNil(value?.eventQueryValues)
         XCTAssertEqual(value?.eventQueryValues?.daysOpenedInLast28, 1)

firefox-ios/firefox-ios-tests/Tests/ClientTests/TermsOfUse/ToUExperiencePointsCalculatorTests.swift

@@ -0,0 +1,65 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import XCTest
+import Shared
+@testable import Client
+
+final class ToUExperiencePointsCalculatorTests: XCTestCase {
+    var userDefaults: MockUserDefaults!
+
+    override func setUp() {
+        super.setUp()
+        userDefaults = MockUserDefaults()
+    }
+
+    override func tearDown() {
+        userDefaults = nil
+        super.tearDown()
+    }
+
+    func testCalculatePoints_ZeroPoints_WhenNoSettingsEnabled() {
+        let calculator = ToUExperiencePointsCalculator(userDefaults: userDefaults, region: "US")
+        XCTAssertEqual(calculator.calculatePoints(), 0)
+    }
+
+    func testCalculatePoints_ZeroPoints_WhenUnsupportedCountry() {
+        let sponsoredKey = ProfilePrefsReader.prefix + PrefsKeys.FeatureFlags.SponsoredShortcuts
+        userDefaults.set(false, forKey: sponsoredKey)
+
+        let calculator = ToUExperiencePointsCalculator(userDefaults: userDefaults, region: "CN")
+        XCTAssertEqual(calculator.calculatePoints(), 0)
+    }
+
+    func testCalculatePoints_OnePoint_WhenETPStrict() {
+        let enabledKey = ProfilePrefsReader.prefix + ContentBlockingConfig.Prefs.EnabledKey
+        let strengthKey = ProfilePrefsReader.prefix + ContentBlockingConfig.Prefs.StrengthKey
+        userDefaults.set(true, forKey: enabledKey)
+        userDefaults.set(BlockingStrength.strict.rawValue, forKey: strengthKey)
+
+        let calculator = ToUExperiencePointsCalculator(userDefaults: userDefaults, region: "US")
+        XCTAssertEqual(calculator.calculatePoints(), 1)
+    }
+
+    func testCalculatePoints_OnePoint_WhenSponsoredDisabled() {
+        let sponsoredKey = ProfilePrefsReader.prefix + PrefsKeys.FeatureFlags.SponsoredShortcuts
+        userDefaults.set(false, forKey: sponsoredKey)
+
+        let calculator = ToUExperiencePointsCalculator(userDefaults: userDefaults, region: "US")
+        XCTAssertEqual(calculator.calculatePoints(), 1)
+    }
+
+    func testCalculatePoints_TwoPoints_WhenBothEnabled() {
+        let enabledKey = ProfilePrefsReader.prefix + ContentBlockingConfig.Prefs.EnabledKey
+        let strengthKey = ProfilePrefsReader.prefix + ContentBlockingConfig.Prefs.StrengthKey
+        let sponsoredKey = ProfilePrefsReader.prefix + PrefsKeys.FeatureFlags.SponsoredShortcuts
+
+        userDefaults.set(true, forKey: enabledKey)
+        userDefaults.set(BlockingStrength.strict.rawValue, forKey: strengthKey)
+        userDefaults.set(false, forKey: sponsoredKey)
+
+        let calculator = ToUExperiencePointsCalculator(userDefaults: userDefaults, region: "DE")
+        XCTAssertEqual(calculator.calculatePoints(), 2)
+    }
+}