Skip to content

[FSSDK-11373] add holdout support and refactor decision logic in DefaultDecisionService #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

[FSSDK-11373] add holdout support and refactor decision logic in DefaultDecisionService #587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5b3e6f0
wip: holdout bucketing logic added
muzahidul-opti Apr 22, 2025
fc15409
wip: add unit test for bucket to variation with 10% traffic for holdout
muzahidul-opti Apr 23, 2025
793d1d5
wip: DecisionService testcases added for holdouts
muzahidul-opti Apr 23, 2025
7a56d47
wip: rename api
muzahidul-opti Apr 24, 2025
e92a3b6
wip: add code documentation
muzahidul-opti Apr 24, 2025
e445f7b
wip: decide reasons test cases adde for holdout
muzahidul-opti Apr 24, 2025
c182d04
wip: add decide test cases for holdout
muzahidul-opti Apr 25, 2025
f2248c6
wip: clean up
muzahidul-opti Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions OptimizelySwiftSDK.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2052,6 +2052,14 @@
98AC97F12DAE4579001405DD /* HoldoutConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC97E12DAE4579001405DD /* HoldoutConfig.swift */; };
98AC97F32DAE9685001405DD /* HoldoutConfigTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC97F22DAE9685001405DD /* HoldoutConfigTests.swift */; };
98AC97F42DAE9685001405DD /* HoldoutConfigTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC97F22DAE9685001405DD /* HoldoutConfigTests.swift */; };
98AC98462DB7B762001405DD /* BucketTests_HoldoutToVariation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC98452DB7B762001405DD /* BucketTests_HoldoutToVariation.swift */; };
98AC98472DB7B762001405DD /* BucketTests_HoldoutToVariation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC98452DB7B762001405DD /* BucketTests_HoldoutToVariation.swift */; };
98AC98492DB8FC29001405DD /* DecisionServiceTests_Features_Holdouts.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC98482DB8FC29001405DD /* DecisionServiceTests_Features_Holdouts.swift */; };
98AC984B2DB8FFE0001405DD /* DecisionServiceTests_Features_Holdouts.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC98482DB8FC29001405DD /* DecisionServiceTests_Features_Holdouts.swift */; };
98AC985E2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC985D2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift */; };
98AC985F2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98AC985D2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift */; };
98D5AE842DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98D5AE832DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift */; };
98D5AE852DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift in Sources */ = {isa = PBXBuildFile; fileRef = 98D5AE832DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift */; };
BD1C3E8524E4399C0084B4DA /* SemanticVersion.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0B97DD93249D327F003DE606 /* SemanticVersion.swift */; };
BD64853C2491474500F30986 /* Optimizely.h in Headers */ = {isa = PBXBuildFile; fileRef = 6E75167A22C520D400B2B157 /* Optimizely.h */; settings = {ATTRIBUTES = (Public, ); }; };
BD64853E2491474500F30986 /* Audience.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6E75169822C520D400B2B157 /* Audience.swift */; };
Expand Down Expand Up @@ -2497,6 +2505,10 @@
987F11D92AF3F56F0083D3F9 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
98AC97E12DAE4579001405DD /* HoldoutConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HoldoutConfig.swift; sourceTree = "<group>"; };
98AC97F22DAE9685001405DD /* HoldoutConfigTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HoldoutConfigTests.swift; sourceTree = "<group>"; };
98AC98452DB7B762001405DD /* BucketTests_HoldoutToVariation.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BucketTests_HoldoutToVariation.swift; sourceTree = "<group>"; };
98AC98482DB8FC29001405DD /* DecisionServiceTests_Features_Holdouts.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DecisionServiceTests_Features_Holdouts.swift; sourceTree = "<group>"; };
98AC985D2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift; sourceTree = "<group>"; };
98D5AE832DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OptimizelyUserContextTests_Decide_Holdouts.swift; sourceTree = "<group>"; };
BD6485812491474500F30986 /* Optimizely.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Optimizely.framework; sourceTree = BUILT_PRODUCTS_DIR; };
C78CAF572445AD8D009FE876 /* OptimizelyJSON.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OptimizelyJSON.swift; sourceTree = "<group>"; };
C78CAF652446DB91009FE876 /* OptimizelyClientTests_OptimizelyJSON.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OptimizelyClientTests_OptimizelyJSON.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -3003,6 +3015,7 @@
6E75198F22C5211100B2B157 /* BucketTests_BucketVariation.swift */,
6E75198C22C5211100B2B157 /* BucketTests_ExpToVariation.swift */,
6E75198322C5211100B2B157 /* BucketTests_GroupToExp.swift */,
98AC98452DB7B762001405DD /* BucketTests_HoldoutToVariation.swift */,
6E75198422C5211100B2B157 /* BucketTests_Others.swift */,
6E75199622C5211100B2B157 /* DatafileHandlerTests.swift */,
6E75199822C5211100B2B157 /* DataStoreTests.swift */,
Expand All @@ -3011,6 +3024,7 @@
6E27ECBD266FD78600B4A6D4 /* DecisionReasonsTests.swift */,
6E75198022C5211100B2B157 /* DecisionServiceTests_Experiments.swift */,
6E75199122C5211100B2B157 /* DecisionServiceTests_Features.swift */,
98AC98482DB8FC29001405DD /* DecisionServiceTests_Features_Holdouts.swift */,
6E75199422C5211100B2B157 /* DecisionServiceTests_Others.swift */,
6E75198622C5211100B2B157 /* DecisionServiceTests_UserProfiles.swift */,
6E75198822C5211100B2B157 /* DefaultLoggerTests.swift */,
Expand All @@ -3031,7 +3045,9 @@
6E75198122C5211100B2B157 /* OptimizelyErrorTests.swift */,
6EC6DD6824AE94820017D296 /* OptimizelyUserContextTests.swift */,
6E2D34B8250AD14000A0CDFE /* OptimizelyUserContextTests_Decide.swift */,
98D5AE832DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift */,
6E7E9B362523F8BF009E4426 /* OptimizelyUserContextTests_Decide_Reasons.swift */,
98AC985D2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift */,
6EB97BCC24C89DFB00068883 /* OptimizelyUserContextTests_Decide_Legacy.swift */,
6E0A72D326C5B9AE00FF92B5 /* OptimizelyUserContextTests_ForcedDecisions.swift */,
98137C562A42BA0F004896EB /* OptimizelyUserContextTests_ODP_Aync_Await.swift */,
Expand Down Expand Up @@ -4882,6 +4898,7 @@
6E9B116322C5487100C22D81 /* BucketTests_GroupToExp.swift in Sources */,
6E7516AF22C520D400B2B157 /* DefaultLogger.swift in Sources */,
6EF8DE2524BD1BB2008B9488 /* OptimizelyDecideOption.swift in Sources */,
98D5AE852DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift in Sources */,
6E75194522C520D500B2B157 /* OPTDecisionService.swift in Sources */,
6E75185522C520D400B2B157 /* ProjectConfig.swift in Sources */,
84F6BAB427FCC5CF004BE62A /* OptimizelyUserContextTests_ODP.swift in Sources */,
Expand All @@ -4901,6 +4918,7 @@
6E75192D22C520D500B2B157 /* DataStoreQueueStack.swift in Sources */,
6E7516D322C520D400B2B157 /* OPTLogger.swift in Sources */,
6E75180122C520D400B2B157 /* DataStoreUserDefaults.swift in Sources */,
98AC98472DB7B762001405DD /* BucketTests_HoldoutToVariation.swift in Sources */,
6E75175722C520D400B2B157 /* LogMessage.swift in Sources */,
6E7516EB22C520D400B2B157 /* OPTEventDispatcher.swift in Sources */,
6E75188522C520D400B2B157 /* TrafficAllocation.swift in Sources */,
Expand Down Expand Up @@ -4954,6 +4972,7 @@
6E27EC9C266EF11000B4A6D4 /* OptimizelyDecisionTests.swift in Sources */,
6E7518D922C520D400B2B157 /* AttributeValue.swift in Sources */,
6E9B116822C5487100C22D81 /* DefaultLoggerTests.swift in Sources */,
98AC985F2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift in Sources */,
C78CAF622445AD8D009FE876 /* OptimizelyJSON.swift in Sources */,
6E75179322C520D400B2B157 /* OptimizelyClient+Extension.swift in Sources */,
6E9B117122C5487100C22D81 /* DecisionServiceTests_Features.swift in Sources */,
Expand Down Expand Up @@ -4983,6 +5002,7 @@
6E7516F722C520D400B2B157 /* OptimizelyError.swift in Sources */,
84861812286D0B8900B7F41B /* OdpSegmentManagerTests.swift in Sources */,
6E75189122C520D400B2B157 /* Project.swift in Sources */,
98AC98492DB8FC29001405DD /* DecisionServiceTests_Features_Holdouts.swift in Sources */,
6E7517F522C520D400B2B157 /* DataStoreMemory.swift in Sources */,
6E0207A9272A11CF008C3711 /* NetworkReachabilityTests.swift in Sources */,
6E75183D22C520D400B2B157 /* EventForDispatch.swift in Sources */,
Expand Down Expand Up @@ -5158,6 +5178,7 @@
6E9B114922C5486E00C22D81 /* BucketTests_GroupToExp.swift in Sources */,
6E75182B22C520D400B2B157 /* BatchEvent.swift in Sources */,
6EF8DE1E24BD1BB2008B9488 /* OptimizelyDecideOption.swift in Sources */,
98D5AE842DBB91C0000D5844 /* OptimizelyUserContextTests_Decide_Holdouts.swift in Sources */,
6E75190322C520D500B2B157 /* Attribute.swift in Sources */,
6E75192722C520D500B2B157 /* DataStoreQueueStack.swift in Sources */,
6E7516F122C520D400B2B157 /* OptimizelyError.swift in Sources */,
Expand All @@ -5166,6 +5187,7 @@
6E75175D22C520D400B2B157 /* AtomicProperty.swift in Sources */,
6E7516D922C520D400B2B157 /* OPTUserProfileService.swift in Sources */,
6E7516E522C520D400B2B157 /* OPTEventDispatcher.swift in Sources */,
98AC98462DB7B762001405DD /* BucketTests_HoldoutToVariation.swift in Sources */,
6E7E9B552523F8C6009E4426 /* OptimizelyUserContextTests_Decide_Legacy.swift in Sources */,
6E652305278E688B00954EA1 /* LruCache.swift in Sources */,
6EC6DD3524ABF6990017D296 /* OptimizelyClient+Decide.swift in Sources */,
Expand Down Expand Up @@ -5230,6 +5252,7 @@
6E7518EB22C520D400B2B157 /* ConditionHolder.swift in Sources */,
6E27EC9B266EF11000B4A6D4 /* OptimizelyDecisionTests.swift in Sources */,
6E75176922C520D400B2B157 /* Utils.swift in Sources */,
98AC985E2DBA6721001405DD /* OptimizelyUserContextTests_Decide_With_Holdouts_Reasons.swift in Sources */,
6E9B114E22C5486E00C22D81 /* DefaultLoggerTests.swift in Sources */,
C78CAF5B2445AD8D009FE876 /* OptimizelyJSON.swift in Sources */,
6E7518C722C520D400B2B157 /* Audience.swift in Sources */,
Expand Down Expand Up @@ -5334,6 +5357,7 @@
6EF8DE2124BD1BB2008B9488 /* OptimizelyDecideOption.swift in Sources */,
8464087928130D3200CCF97D /* Integration.swift in Sources */,
6E9B118122C5488100C22D81 /* ConditionLeafTests.swift in Sources */,
98AC984B2DB8FFE0001405DD /* DecisionServiceTests_Features_Holdouts.swift in Sources */,
6E75184522C520D400B2B157 /* Event.swift in Sources */,
6E75191122C520D500B2B157 /* BackgroundingCallbacks.swift in Sources */,
848617D12863DC2700B7F41B /* OdpSegmentManager.swift in Sources */,
Expand Down
2 changes: 0 additions & 2 deletions Sources/Data Model/FeatureFlag.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ struct FeatureFlag: Codable, Equatable, OptimizelyFeature {
case variables
}

// var holdoutIds: [String] = []

// MARK: - OptimizelyConfig

var experimentsMap: [String: OptimizelyExperiment] = [:]
Expand Down
1 change: 0 additions & 1 deletion Sources/Data Model/HoldoutConfig.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,3 @@ struct HoldoutConfig {
return holdoutIdMap[id]
}
}

4 changes: 2 additions & 2 deletions Sources/Implementation/DecisionInfo.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ struct DecisionInfo {
let decisionType: Constants.DecisionType

/// The experiment that the decision variation belongs to.
var experiment: Experiment?
var experiment: ExperimentCore?

/// The variation selected by the decision.
var variation: Variation?
Expand Down Expand Up @@ -58,7 +58,7 @@ struct DecisionInfo {
var decisionEventDispatched: Bool

init(decisionType: Constants.DecisionType,
experiment: Experiment? = nil,
experiment: ExperimentCore? = nil,
variation: Variation? = nil,
source: String? = nil,
feature: FeatureFlag? = nil,
Expand Down
2 changes: 1 addition & 1 deletion Sources/Implementation/DefaultBucketer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class DefaultBucketer: OPTBucketer {
return DecisionResponse(result: nil, reasons: reasons)
}

func bucketToVariation(experiment: Experiment,
func bucketToVariation(experiment: ExperimentCore,
bucketingId: String) -> DecisionResponse<Variation> {
let reasons = DecisionReasons()

Expand Down
Loading
Loading