Skip to content

Commit

Permalink
change api (#1133)
Browse files Browse the repository at this point in the history 
Task/Issue URL:
https://app.asana.com/0/1204186595873227/1208964427775425/f
iOS PR:  duckduckgo/iOS#3732
macOS PR: duckduckgo/macos-browser#3670
What kind of version bump will this require?: Minor
  • Loading branch information
@SabrinaTardio
SabrinaTardio authored Dec 17, 2024
1 parent 08c3dca commit b71ed70
Show file tree
Hide file tree
Showing 2 changed files with 171 additions and 55 deletions.
96 changes: 65 additions & 31 deletions Sources/PixelExperimentKit/PixelExperimentKit.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import BrowserServicesKit
import Foundation

public typealias ConversionWindow = ClosedRange<Int>
public typealias NumberOfCalls = Int

struct ExperimentEvent: PixelKitEvent {
var name: String
Expand Down Expand Up @@ -72,7 +73,7 @@ extension PixelKit {
ExperimentConfig.fireFunction(event, .uniqueByNameAndParameters, false)
}

/// Fires a pixel for a specific action in an experiment, based on conversion window and value thresholds (if value is a number).
/// Fires a pixel for a specific action in an experiment, based on conversion window and value.
/// - Parameters:
/// - subfeatureID: Identifier for the subfeature associated with the experiment.
/// - metric: The name of the metric being tracked (e.g., "searches").
Expand All @@ -82,7 +83,7 @@ extension PixelKit {
/// This function:
/// 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).
/// 3. Sends the pixel if not sent before (unique by name and parameter)
public static func fireExperimentPixel(for subfeatureID: SubfeatureID,
metric: String,
conversionWindowDays: ConversionWindow,
Expand All @@ -94,11 +95,41 @@ extension PixelKit {
}
guard let experimentData = featureFlagger.getAllActiveExperiments()[subfeatureID] else { return }

// Check if within conversion window
guard isUserInConversionWindow(conversionWindowDays, enrollmentDate: experimentData.enrollmentDate) else { return }

// Define event
let event = event(for: subfeatureID, experimentData: experimentData, conversionWindowDays: conversionWindowDays, metric: metric, value: value)
ExperimentConfig.fireFunction(event, .uniqueByNameAndParameters, false)
}

/// Fires a pixel for a specific action in an experiment, based on conversion window and value thresholds.
/// - Parameters:
/// - subfeatureID: Identifier for the subfeature associated with the experiment.
/// - metric: The name of the metric being tracked (e.g., "searches").
/// - conversionWindowDays: The range of days after enrollment during which the action is valid.
/// - numberOfCalls: target number of actions required to fire the pixel.
///
/// This function:
/// 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 fireExperimentPixelIfThresholdReached(for subfeatureID: SubfeatureID,
metric: String,
conversionWindowDays: ConversionWindow,
threshold: NumberOfCalls) {
// 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)
numberOfCalls: threshold)
}

/// Fires search-related experiment pixels for all active experiments.
Expand Down Expand Up @@ -172,7 +203,7 @@ extension PixelKit {
experimentData: experimentData,
metric: metric,
conversionWindowDays: range,
value: "\(value)"
numberOfCalls: value
)
}
}
Expand All @@ -182,39 +213,24 @@ extension PixelKit {
experimentData: ExperimentData,
metric: String,
conversionWindowDays: ConversionWindow,
value: String) {
numberOfCalls: Int) {
// Set parameters, event name, store key
let eventName = "\(Constants.metricsEventPrefix)_\(subfeatureID)_\(experimentData.cohortID)"
let conversionWindowValue = (conversionWindowDays.lowerBound != conversionWindowDays.upperBound) ?
"\(conversionWindowDays.lowerBound)-\(conversionWindowDays.upperBound)" :
"\(conversionWindowDays.lowerBound)"
let parameters: [String: String] = [
Constants.metricKey: metric,
Constants.conversionWindowDaysKey: conversionWindowValue,
Constants.valueKey: value,
Constants.enrollmentDateKey: experimentData.enrollmentDate.toYYYYMMDDInET()
]
let event = ExperimentEvent(name: eventName, parameters: parameters)
let eventStoreKey = "\(eventName)_\(parameters.toString())"
let event = event(for: subfeatureID, experimentData: experimentData, conversionWindowDays: conversionWindowDays, metric: metric, value: String(numberOfCalls))
let parameters = parameters(metric: metric, conversionWindowDays: conversionWindowDays, value: String(numberOfCalls), experimentData: experimentData)
let eventStoreKey = "\(event.name)_\(parameters.toString())"

// Determine if the user is within the conversion window
let isInWindow = isUserInConversionWindow(conversionWindowDays, enrollmentDate: experimentData.enrollmentDate)

// Check if value is a number
if let numberOfAction = NumberOfActions(value), numberOfAction > 1 {
// Increment or remove based on conversion window status
let shouldSendPixel = ExperimentConfig.eventTracker.incrementAndCheckThreshold(
forKey: eventStoreKey,
threshold: numberOfAction,
isInWindow: isInWindow
)
// Increment or remove based on conversion window status
let shouldSendPixel = ExperimentConfig.eventTracker.incrementAndCheckThreshold(
forKey: eventStoreKey,
threshold: numberOfCalls,
isInWindow: isInWindow
)

// Send the pixel only if conditions are met
if shouldSendPixel {
ExperimentConfig.fireFunction(event, .uniqueByNameAndParameters, false)
}
} else if isInWindow {
// If value is not a number, send the pixel only if within the window
// Send the pixel only if conditions are met
if shouldSendPixel {
ExperimentConfig.fireFunction(event, .uniqueByNameAndParameters, false)
}
}
Expand All @@ -233,6 +249,24 @@ extension PixelKit {
return currentDate >= calendar.startOfDay(for: startOfWindow) &&
currentDate <= calendar.startOfDay(for: endOfWindow)
}

private static func event(for subfeatureID: SubfeatureID, experimentData: ExperimentData, conversionWindowDays: ConversionWindow, metric: String, value: String) -> ExperimentEvent{
let eventName = "\(Constants.metricsEventPrefix)_\(subfeatureID)_\(experimentData.cohortID)"
let parameters = parameters(metric: metric, conversionWindowDays: conversionWindowDays, value: value, experimentData: experimentData)
return ExperimentEvent(name: eventName, parameters: parameters)
}

private static func parameters(metric: String, conversionWindowDays: ConversionWindow, value: String, experimentData: ExperimentData) -> [String: String] {
let conversionWindowValue = (conversionWindowDays.lowerBound != conversionWindowDays.upperBound) ?
"\(conversionWindowDays.lowerBound)-\(conversionWindowDays.upperBound)" :
"\(conversionWindowDays.lowerBound)"
return [
Constants.metricKey: metric,
Constants.conversionWindowDaysKey: conversionWindowValue,
Constants.valueKey: value,
Constants.enrollmentDateKey: experimentData.enrollmentDate.toYYYYMMDDInET()
]
}
}

extension Date {
Expand Down
Loading

0 comments on commit b71ed70

Please sign in to comment.