experiment default metrics pixels

Sources/PixelExperimentKit/ExperimentEventTracker.swift

@@ -18,6 +18,10 @@
 
 import Foundation
 
+public typealias ThresholdCheckResult = Bool
+public typealias ExprimentPixelNameAndParameters = String
+public typealias NumberOfActions = Int
+
 public protocol ExperimentActionPixelStore {
      func removeObject(forKey defaultName: String)
      func integer(forKey defaultName: String) -> Int
@@ -38,18 +42,18 @@ public protocol ExperimentEventTracking {
     ///   - threshold: The count threshold that triggers a return of `true`.
     ///   - isInWindow: A flag indicating if the count should be considered (e.g., within a time window).
     /// - Returns: `true` if the threshold is exceeded and the count is reset, otherwise `false`.
-    func incrementAndCheckThreshold(forKey key: String, threshold: Int, isInWindow: Bool) -> Bool
+    func incrementAndCheckThreshold(forKey key: ExprimentPixelNameAndParameters, threshold: NumberOfActions, isInWindow: Bool) -> ThresholdCheckResult
 }
 
 public struct ExperimentEventTracker: ExperimentEventTracking {
-    let store: ExperimentActionPixelStore
+    private let store: ExperimentActionPixelStore
     private let syncQueue = DispatchQueue(label: "com.pixelkit.experimentActionSyncQueue")
 
     public init(store: ExperimentActionPixelStore = UserDefaults.standard) {
         self.store = store
     }
 
-    public func incrementAndCheckThreshold(forKey key: String, threshold: Int, isInWindow: Bool) -> Bool {
+    public func incrementAndCheckThreshold(forKey key: ExprimentPixelNameAndParameters, threshold: NumberOfActions, isInWindow: Bool) -> ThresholdCheckResult {
         syncQueue.sync {
             // Remove the key if is not in window
             guard isInWindow else {

Sources/PixelExperimentKit/PixelExperimentKit.swift

@@ -20,6 +20,8 @@ import PixelKit
 import BrowserServicesKit
 import Foundation
 
+public typealias ConversionWindow = ClosedRange<Int>
+
 struct ExperimentEvent: PixelKitEvent {
     var name: String
     var parameters: [String: String]?
@@ -81,15 +83,22 @@ extension PixelKit {
     /// 1. Validates if the experiment is active.
     /// 2. Ensures the user is within the specified conversion window.
     /// 3. Tracks actions performed and sends the pixel once the target value is reached (if applicable).
-    public static func fireExperimentPixel(for subfeatureID: SubfeatureID, metric: String, conversionWindowDays: ClosedRange<Int>, value: String) {
+    public static func fireExperimentPixel(for subfeatureID: SubfeatureID,
+                                           metric: String,
+                                           conversionWindowDays: ConversionWindow,
+                                           value: String) {
         // Check is active experiment for user
         guard let featureFlagger = ExperimentConfig.featureFlagger else {
             assertionFailure("PixelKit is not configured for experiments")
             return
         }
         guard let experimentData = featureFlagger.getAllActiveExperiments()[subfeatureID] else { return }
 
-        fireExperimentPixelForActiveExperiment(subfeatureID, experimentData: experimentData, metric: metric, conversionWindowDays: conversionWindowDays, value: value)
+        fireExperimentPixelForActiveExperiment(subfeatureID,
+                                               experimentData: experimentData,
+                                               metric: metric,
+                                               conversionWindowDays: conversionWindowDays,
+                                               value: value)
     }
 
     /// Fires search-related experiment pixels for all active experiments.
@@ -99,7 +108,7 @@ extension PixelKit {
     /// - The value and conversion windows define when and how many search actions
     ///   must occur before the pixel is fired.
     public static func fireSearchExperimentPixels() {
-        let valueConversionDictionary: [Int: [ClosedRange<Int>]] = [
+        let valueConversionDictionary: [NumberOfActions: [ConversionWindow]] = [
             1: [0...0, 1...1, 2...2, 3...3, 4...4, 5...5, 6...6, 7...7, 5...7],
             4: [5...7, 8...15],
             6: [5...7, 8...15],
@@ -128,7 +137,7 @@ extension PixelKit {
     /// - The value and conversion windows define when and how many app usage actions
     ///   must occur before the pixel is fired.
     public static func fireAppRetentionExperimentPixels() {
-        let valueConversionDictionary: [Int: [ClosedRange<Int>]] = [
+        let valueConversionDictionary: [NumberOfActions: [ConversionWindow]] = [
             1: [1...1, 2...2, 3...3, 4...4, 5...5, 6...6, 7...7, 5...7],
             4: [5...7, 8...15],
             6: [5...7, 8...15],
@@ -154,7 +163,7 @@ extension PixelKit {
         for experiment: SubfeatureID,
         experimentData: ExperimentData,
         metric: String,
-        valueConversionDictionary: [Int: [ClosedRange<Int>]]
+        valueConversionDictionary: [NumberOfActions: [ConversionWindow]]
     ) {
         valueConversionDictionary.forEach { value, ranges in
             ranges.forEach { range in
@@ -169,7 +178,11 @@ extension PixelKit {
         }
     }
 
-    private static func fireExperimentPixelForActiveExperiment(_ subfeatureID: SubfeatureID, experimentData: ExperimentData, metric: String, conversionWindowDays: ClosedRange<Int>, value: String) {
+    private static func fireExperimentPixelForActiveExperiment(_ subfeatureID: SubfeatureID,
+                                                               experimentData: ExperimentData,
+                                                               metric: String,
+                                                               conversionWindowDays: ConversionWindow,
+                                                               value: String) {
         // Set parameters, event name, store key
         let eventName = "\(Constants.metricsEventPrefix)_\(subfeatureID)_\(experimentData.cohortID)"
         let conversionWindowValue = (conversionWindowDays.lowerBound != conversionWindowDays.upperBound) ?
@@ -188,7 +201,7 @@ extension PixelKit {
         let isInWindow = isUserInConversionWindow(conversionWindowDays, enrollmentDate: experimentData.enrollmentDate)
 
         // Check if value is a number
-        if let numberOfAction = Int(value), numberOfAction > 1 {
+        if let numberOfAction = NumberOfActions(value), numberOfAction > 1 {
             // Increment or remove based on conversion window status
             let shouldSendPixel = ExperimentConfig.eventTracker.incrementAndCheckThreshold(
                 forKey: eventStoreKey,
@@ -207,7 +220,7 @@ extension PixelKit {
     }
 
     private static func isUserInConversionWindow(
-        _ conversionWindowRange: ClosedRange<Int>,
+        _ conversionWindowRange: ConversionWindow,
         enrollmentDate: Date
     ) -> Bool {
         let calendar = Calendar.current

Sources/PixelKit/PixelKit.swift

@@ -152,7 +152,7 @@ public final class PixelKit {
     }
 
     private var dryRun: Bool
-    private let source: String?
+    public let source: String?
     private let pixelCalendar: Calendar
 
     public init(dryRun: Bool,
@@ -396,8 +396,11 @@ public final class PixelKit {
             fireRequest(pixelName, headers, parameters, allowedQueryReservedCharacters, callBackOnMainThread, onComplete)
         }
 
-    // Needs to be updated when fully adopted by iOS
+    // Only set up for macOS and for Experiments
     private func prefixedAndSuffixedName(for event: Event) -> String {
+        if event.name.hasPrefix("experiment") {
+            return addPlatformSuffix(to: event.name)
+        }
         if event.name.hasPrefix("m_mac_") {
             // Can be a debug event or not, if already prefixed the name remains unchanged
             return event.name
@@ -408,22 +411,26 @@ public final class PixelKit {
             // Special kind of pixel event that don't follow the standard naming conventions
             return nonStandardEvent.name
         } else {
-            if let source {
-                switch source {
-                case Source.iOS.rawValue:
-                    return "m_\(event.name)_ios_phone"
-                case Source.iPadOS.rawValue:
-                    return "m_\(event.name)_ios_tablet"
-                case Source.macDMG.rawValue, Source.macStore.rawValue:
-                    return "m_mac_\(event.name)"
-                default:
-                    return "m_mac_\(event.name)"
-                }
-            }
             return "m_mac_\(event.name)"
         }
     }
 
+    private func addPlatformSuffix(to name: String) -> String {
+        if let source {
+            switch source {
+            case Source.iOS.rawValue:
+                return "\(name)_ios_phone"
+            case Source.iPadOS.rawValue:
+                return "\(name)_ios_tablet"
+            case Source.macStore.rawValue, Source.macDMG.rawValue:
+                return "\(name)_mac"
+            default:
+                return name
+            }
+        }
+        return name
+    }
+
     public func fire(_ event: Event,
                      frequency: Frequency = .standard,
                      withHeaders headers: [String: String]? = nil,