[FSSDK-11372] assign holdoutIds to feature flags

Sources/Data Model/FeatureFlag.swift

@@ -35,6 +35,8 @@ struct FeatureFlag: Codable, Equatable, OptimizelyFeature {
         case variables
     }
 
+//    var holdoutIds: [String] = []
+
     // MARK: - OptimizelyConfig
 
     var experimentsMap: [String: OptimizelyExperiment] = [:]

Sources/Data Model/Holdout.swift

@@ -39,11 +39,10 @@ struct Holdout: Codable, ExperimentCore {
         case id, key, status, layerId, variations, trafficAllocation, audienceIds, audienceConditions, includedFlags, excludedFlags
     }
 
-    var variationsMap: [String : OptimizelyVariation] = [:]
+    var variationsMap: [String: OptimizelyVariation] = [:]
     // replace with serialized string representation with audience names when ProjectConfig is ready
     var audiences: String = ""
 
-
     init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
@@ -76,7 +75,6 @@ extension Holdout: Equatable {
     }
 }
 
-
 extension Holdout {
     var isActivated: Bool {
         return status == .running

Sources/Data Model/Project.swift

@@ -46,7 +46,8 @@ struct Project: Codable, Equatable {
     var sendFlagDecisions: Bool?
     var sdkKey: String?
     var environmentKey: String?
-
+    // Holdouts
+    var holdouts: [Holdout]
     let logger = OPTLoggerFactory.getLogger()
 
     // Required since logger is not decodable
@@ -56,12 +57,42 @@ struct Project: Codable, Equatable {
         // V3
         case anonymizeIP
         // V4
-        case rollouts, integrations, typedAudiences, featureFlags, botFiltering, sendFlagDecisions, sdkKey, environmentKey
+        case rollouts, integrations, typedAudiences, featureFlags, botFiltering, sendFlagDecisions, sdkKey, environmentKey, holdouts
+    }
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        // V2
+        version = try container.decode(String.self, forKey: .version)
+        projectId = try container.decode(String.self, forKey: .projectId)
+        experiments = try container.decode([Experiment].self, forKey: .experiments)
+        audiences = try container.decode([Audience].self, forKey: .audiences)
+        groups = try container.decode([Group].self, forKey: .groups)
+        attributes = try container.decode([Attribute].self, forKey: .attributes)
+        accountId = try container.decode(String.self, forKey: .accountId)
+        events = try container.decode([Event].self, forKey: .events)
+        revision = try container.decode(String.self, forKey: .revision)
+
+        // V3
+        anonymizeIP = try container.decode(Bool.self, forKey: .anonymizeIP)
+
+        // V4
+        rollouts = try container.decode([Rollout].self, forKey: .rollouts)
+        integrations = try container.decodeIfPresent([Integration].self, forKey: .integrations)
+        typedAudiences = try container.decodeIfPresent([Audience].self, forKey: .typedAudiences)
+        featureFlags = try container.decode([FeatureFlag].self, forKey: .featureFlags)
+        botFiltering = try container.decodeIfPresent(Bool.self, forKey: .botFiltering)
+        sendFlagDecisions = try container.decodeIfPresent(Bool.self, forKey: .sendFlagDecisions)
+        sdkKey = try container.decodeIfPresent(String.self, forKey: .sdkKey)
+        environmentKey = try container.decodeIfPresent(String.self, forKey: .environmentKey)
+        // Holdouts - defaults to empty array if key is not present
+        holdouts = try container.decodeIfPresent([Holdout].self, forKey: .holdouts) ?? []
     }
 
     // Required since logger is not equatable
     static func == (lhs: Project, rhs: Project) -> Bool {
-        return lhs.version == rhs.version && lhs.projectId == rhs.projectId && lhs.experiments == rhs.experiments &&
+        return lhs.version == rhs.version && lhs.projectId == rhs.projectId && lhs.experiments == rhs.experiments && lhs.holdouts == rhs.holdouts &&
             lhs.audiences == rhs.audiences && lhs.groups == rhs.groups && lhs.attributes == rhs.attributes &&
             lhs.accountId == rhs.accountId && lhs.events == rhs.events && lhs.revision == rhs.revision &&
             lhs.anonymizeIP == rhs.anonymizeIP && lhs.rollouts == rhs.rollouts &&

Sources/Data Model/ProjectConfig.swift

@@ -17,12 +17,12 @@
 import Foundation
 
 class ProjectConfig {
-
     var project: Project! {
         didSet {
             updateProjectDependentProps()
         }
     }
+
     let logger = OPTLoggerFactory.getLogger()
 
     // local runtime forcedVariations [UserId: [ExperimentId: VariationId]]
@@ -40,6 +40,8 @@ class ProjectConfig {
     var allExperiments = [Experiment]()
     var flagVariationsMap = [String: [Variation]]()
     var allSegments = [String]()
+    var holdoutIdMap = [String: Holdout]()
+    var flagHoldoutsMap: [String: [String]] = [:]
 
     // MARK: - Init
 
@@ -66,8 +68,18 @@ class ProjectConfig {
     init() {}
 
     func updateProjectDependentProps() {
+
         self.allExperiments = project.experiments + project.groups.map { $0.experiments }.flatMap { $0 }
 
+        // Reset flag holdouts mapping with the change of datafile
+        flagHoldoutsMap = [:]
+
+        holdoutIdMap = {
+            var map = [String: Holdout]()
+            project.holdouts.forEach { map[$0.id] = $0 }
+            return map
+        }()
+
         self.experimentKeyMap = {
             var map = [String: Experiment]()
             allExperiments.forEach { exp in
@@ -155,6 +167,42 @@ class ProjectConfig {
 
     }
 
+    func getHoldoutIdsForFlag(id: String) -> [String] {
+        guard !project.holdouts.isEmpty else { return [] }
+
+        if let holdoutIds = flagHoldoutsMap[id] {
+            return holdoutIds
+        }
+
+        updateHoldoutsMapForFlag(id: id)
+
+        return flagHoldoutsMap[id] ?? []
+    }
+
+    private func updateHoldoutsMapForFlag(id: String) {
+        var holdoutIds = [String]()
+
+        for holdout in project.holdouts {
+            switch (holdout.includedFlags.isEmpty, holdout.excludedFlags.isEmpty) {
+                case (true, true):
+                    // Global holdout
+                    holdoutIds.append(holdout.id)
+
+                case (false, _):
+                    if holdout.includedFlags.contains(id) {
+                        holdoutIds.append(holdout.id)
+                    }
+
+                case (_, false):
+                    if !holdout.excludedFlags.contains(id) {
+                        holdoutIds.append(holdout.id)
+                    }
+            }
+        }
+
+        flagHoldoutsMap[id] = holdoutIds
+    }
+
     func getAllRulesForFlag(_ flag: FeatureFlag) -> [Experiment] {
         var rules = flag.experimentIds.compactMap { experimentIdMap[$0] }
         let rollout = self.rolloutIdMap[flag.rolloutId]
@@ -270,6 +318,13 @@ extension ProjectConfig {
         return rolloutIdMap[id]
     }
 
+    /**
+     * Get a Holdout object for an Id.
+     */
+    func getHoldout(id: String) -> Holdout? {
+        return holdoutIdMap[id]
+    }
+
     /**
      * Gets an event for a corresponding event key
      */

Tests/OptimizelyTests-DataModel/HoldoutTests.swift

@@ -20,15 +20,50 @@ import XCTest
 // MARK: - Sample Data
 
 class HoldoutTests: XCTestCase {
+    static var variationData: [String: Any] = ["id": "553339214",
+                                            "key": "house",
+                                            "featureEnabled": true,
+                                            "variables": [["id": "553339214", "value": "100"]]]
+
+    static var trafficAllocationData: [String: Any] = ["entityId": "553339214", "endOfRange": 5000]
+
+    static var conditionHolderData: [Any] = ["or", ["name": "geo",
+                                           "type": "custom_attribute",
+                                           "match": "exact",
+                                           "value": 30]]
+
     /// Global holoout without  included and excluded key
     static var sampleData: [String: Any] = ["id": "11111",
                                             "key": "background",
                                             "status": "Running",
                                             "layerId": "22222",
-                                            "variations": [VariationTests.sampleData],
-                                            "trafficAllocation": [TrafficAllocationTests.sampleData],
+                                            "variations": [HoldoutTests.variationData],
+                                            "trafficAllocation": [HoldoutTests.trafficAllocationData],
+                                            "audienceIds": ["33333"],
+                                            "audienceConditions": HoldoutTests.conditionHolderData]
+
+    static var sampleDataWithIncludedFlags: [String: Any] = ["id": "11111",
+                                            "key": "background",
+                                            "status": "Running",
+                                            "layerId": "22222",
+                                            "variations": [HoldoutTests.variationData],
+                                            "trafficAllocation": [HoldoutTests.trafficAllocationData],
                                             "audienceIds": ["33333"],
-                                            "audienceConditions": ConditionHolderTests.sampleData]
+                                            "audienceConditions": HoldoutTests.conditionHolderData,
+                                            "includedFlags": ["4444", "5555"]]
+
+    static var sampleDataWithIncludedAndExcludedFlags: [String: Any] = ["id": "11111",
+                                                             "key": "background",
+                                                             "status": "Running",
+                                                             "layerId": "22222",
+                                                             "variations": [HoldoutTests.variationData],
+                                                             "trafficAllocation": [HoldoutTests.trafficAllocationData],
+                                                             "audienceIds": ["33333"],
+                                                             "audienceConditions": HoldoutTests.conditionHolderData,
+                                                             "includedFlags": ["4444", "5555"],
+                                                             "excludedFlags": ["8888", "9999"]]
+
+
 
 }
 
@@ -44,44 +79,43 @@ extension HoldoutTests {
         XCTAssert(model.key == "background")
         XCTAssert(model.status == .running)
         XCTAssert(model.layerId == "22222")
-        XCTAssert(model.variations == [try! OTUtils.model(from: VariationTests.sampleData)])
-        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: TrafficAllocationTests.sampleData)])
+        XCTAssert(model.variations == [try! OTUtils.model(from: HoldoutTests.variationData)])
+        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: HoldoutTests.trafficAllocationData)])
         XCTAssert(model.audienceIds == ["33333"])
-        XCTAssert(model.audienceConditions == (try! OTUtils.model(from: ConditionHolderTests.sampleData)))
+        XCTAssert(model.audienceConditions == (try! OTUtils.model(from: HoldoutTests.conditionHolderData)))
     }
 
     func testDecodeSuccessWithIncludedFlags() {
-        var data: [String: Any] = HoldoutTests.sampleData
-        data["includedFlags"] = ["4444", "5555"]
+        let data: [String: Any] = HoldoutTests.sampleDataWithIncludedFlags
 
         let model: Holdout = try! OTUtils.model(from: data)
 
         XCTAssert(model.id == "11111")
         XCTAssert(model.key == "background")
         XCTAssert(model.status == .running)
         XCTAssert(model.layerId == "22222")
-        XCTAssert(model.variations == [try! OTUtils.model(from: VariationTests.sampleData)])
-        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: TrafficAllocationTests.sampleData)])
+        XCTAssert(model.variations == [try! OTUtils.model(from: HoldoutTests.variationData)])
+        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: HoldoutTests.trafficAllocationData)])
         XCTAssert(model.audienceIds == ["33333"])
-        XCTAssert(model.audienceConditions == (try! OTUtils.model(from: ConditionHolderTests.sampleData)))
+        XCTAssert(model.audienceConditions == (try! OTUtils.model(from: HoldoutTests.conditionHolderData)))
         XCTAssertEqual(model.includedFlags, ["4444", "5555"])
     }
 
-    func testDecodeSuccessWithExcludedFlags() {
-        var data: [String: Any] = HoldoutTests.sampleData
-        data["excludedFlags"] = ["4444", "5555"]
+    func testDecodeSuccessWithIncludedAndExcludedFlags() {
+        let data: [String: Any] = HoldoutTests.sampleDataWithIncludedAndExcludedFlags
 
         let model: Holdout = try! OTUtils.model(from: data)
 
         XCTAssert(model.id == "11111")
         XCTAssert(model.key == "background")
         XCTAssert(model.status == .running)
         XCTAssert(model.layerId == "22222")
-        XCTAssert(model.variations == [try! OTUtils.model(from: VariationTests.sampleData)])
-        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: TrafficAllocationTests.sampleData)])
+        XCTAssert(model.variations == [try! OTUtils.model(from: HoldoutTests.variationData)])
+        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: HoldoutTests.trafficAllocationData)])
         XCTAssert(model.audienceIds == ["33333"])
-        XCTAssert(model.audienceConditions == (try! OTUtils.model(from: ConditionHolderTests.sampleData)))
-        XCTAssertEqual(model.excludedFlags, ["4444", "5555"])
+        XCTAssert(model.audienceConditions == (try! OTUtils.model(from: HoldoutTests.conditionHolderData)))
+        XCTAssertEqual(model.includedFlags, ["4444", "5555"])
+        XCTAssertEqual(model.excludedFlags, ["8888", "9999"])
     }
 
 
@@ -95,8 +129,8 @@ extension HoldoutTests {
         XCTAssert(model.key == "background")
         XCTAssert(model.status == .running)
         XCTAssert(model.layerId == "22222")
-        XCTAssert(model.variations == [try! OTUtils.model(from: VariationTests.sampleData)])
-        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: TrafficAllocationTests.sampleData)])
+        XCTAssert(model.variations == [try! OTUtils.model(from: HoldoutTests.variationData)])
+        XCTAssert(model.trafficAllocation == [try! OTUtils.model(from: HoldoutTests.trafficAllocationData)])
         XCTAssert(model.audienceIds == ["33333"])
     }
 
@@ -172,8 +206,8 @@ extension HoldoutTests {
                                          "key": "background",
                                          "status": "Running",
                                          "layerId": "22222",
-                                         "variations": [VariationTests.sampleData],
-                                         "trafficAllocation": [TrafficAllocationTests.sampleData],
+                                         "variations": [HoldoutTests.variationData],
+                                         "trafficAllocation": [HoldoutTests.trafficAllocationData],
                                          "audienceIds": [],
                                          "audienceConditions": [],
                                          "forcedVariations": ["12345": "1234567890"]]