Skip to content

fix: Targeting rollout should move to fallback rule when bucketing fails. #323

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

Merged
merged 4 commits into from
May 13, 2020
Merged

fix: Targeting rollout should move to fallback rule when bucketing fails. #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1907574
implementations and unit tests added.
yasirfolio3 May 11, 2020
3e77450
headers updated.
yasirfolio3 May 12, 2020
7e8daa0
Suggested changes made.
yasirfolio3 May 13, 2020
1038c2c
Merge branch 'master' into yasir/OASIS-6334
jaeopt May 13, 2020
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
6 changes: 3 additions & 3 deletions Sources/Implementation/DefaultDecisionService.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2019, Optimizely, Inc. and contributors *
* Copyright 2019-2020, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand Down Expand Up @@ -200,9 +200,9 @@ class DefaultDecisionService: OPTDecisionService {
logger.d(.userBucketedIntoTargetingRule(userId, index + 1))

return variation
} else {
logger.d(.userNotBucketedIntoTargetingRule(userId, index + 1))
}
logger.d(.userNotBucketedIntoTargetingRule(userId, index + 1))
break
} else {
logger.d(.userDoesntMeetConditionsForTargetingRule(userId, index + 1))
}
Expand Down
181 changes: 154 additions & 27 deletions Tests/OptimizelyTests-Common/DecisionServiceTests_Features.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2019, Optimizely, Inc. and contributors *
* Copyright 2019-2020, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand Down Expand Up @@ -27,7 +27,9 @@ class DecisionServiceTests_Features: XCTestCase {
var kExperimentId = "country11"
var kRolloutId = "rollout11"
var kRolloutExperimentId = "rolloutExp11"

var kRolloutExperimentId2 = "rolloutExp12"
var kRolloutExperimentId3 = "rolloutExp13"

var kVariationKeyA = "a"
var kVariationKeyB = "b"
var kVariationKeyC = "c"
Expand All @@ -37,11 +39,21 @@ class DecisionServiceTests_Features: XCTestCase {
var kAudienceIdAge = "20"
var kAudienceIdInvalid = "9999999"

var kRolloutVariationKeyA = "rolloutA"
var kRolloutVariationKeyB = "rolloutB"
var kRolloutVariationKeyC = "rolloutC"

var kRolloutAudienceIdAge1 = "30"
var kRolloutAudienceIdAge2 = "40"

var kAttributesCountryMatch: [String: Any] = ["country": "us"]
var kAttributesCountryNotMatch: [String: Any] = ["country": "ca"]
var kAttributesAgeMatch: [String: Any] = ["age": 30]
var kAttributesAgeNotMatch: [String: Any] = ["age": 10]
var kAttributesEmpty: [String: Any] = [:]
var kAttributesRolloutAge1Match: [String: Any] = ["age": 20]
var kAttributesRolloutAge2Match: [String: Any] = ["age": 30]
var kAttributesRolloutNotMatch: [String: Any] = ["age": 40]

var experiment: Experiment!
var variation: Variation!
Expand Down Expand Up @@ -127,32 +139,93 @@ class DecisionServiceTests_Features: XCTestCase {
var sampleRolloutData: [String: Any] { return
[
"id": kRolloutId,
"experiments": [sampleRolloutExperimentData]
"experiments": sampleRolloutExperimentData
]
}

var sampleRolloutExperimentData: [String: Any] { return
var sampleRolloutExperimentData: [[String: Any]] { return
[
"status": "Running",
"id": kRolloutExperimentId,
"key": "rolloutExp",
"layerId": "10420273888",
"trafficAllocation": [
[
"entityId": "10389700000",
"endOfRange": 10000
]
[
"status": "Running",
"id": kRolloutExperimentId,
"key": "rolloutExp",
"layerId": "10420273888",
"trafficAllocation": [
[
"entityId": "10389700000",
"endOfRange": 10000
]
],
"audienceIds": [kRolloutAudienceIdAge1],
"variations": [
[
"variables": [],
"id": "10389700000",
"key": kRolloutVariationKeyA,
"featureEnabled": true
]
],
"forcedVariations": [:]
],
"audienceIds": [],
"variations": [
[
"variables": [],
"id": "10389700000",
"key": kVariationKeyA,
"featureEnabled": true
]
[
"status": "Running",
"id": kRolloutExperimentId2,
"key": "rolloutExp1",
"layerId": "10420273889",
"trafficAllocation": [
[
"entityId": "10389700000",
"endOfRange": 10000
]
],
"audienceIds": [kRolloutAudienceIdAge2],
"variations": [
[
"variables": [],
"id": "10389700000",
"key": kRolloutVariationKeyB,
"featureEnabled": true
]
],
"forcedVariations": [:]
],
"forcedVariations": [:]
[
"status": "Running",
"id": kRolloutExperimentId3,
"key": "rolloutExp2",
"layerId": "10420273890",
"trafficAllocation": [
[
"entityId": "10389700000",
"endOfRange": 10000
]
],
"audienceIds": [],
"variations": [
[
"variables": [],
"id": "10389700000",
"key": kRolloutVariationKeyC,
"featureEnabled": true
]
],
"forcedVariations": [:]
]
]
}

var sampleRolloutTypedAudiencesData: [[String: Any]] { return
[
[
"id": kRolloutAudienceIdAge1,
"conditions": [ "type": "custom_attribute", "name": "age", "match": "lt", "value": 30 ],
"name": "age"
],
[
"id": kRolloutAudienceIdAge2,
"conditions": [ "type": "custom_attribute", "name": "age", "match": "lt", "value": 40 ],
"name": "age"
]
]
}

Expand Down Expand Up @@ -222,14 +295,15 @@ extension DecisionServiceTests_Features {
func testGetVariationForFeatureRollout() {
// rollout set
self.config.project.rollouts = [try! OTUtils.model(from: sampleRolloutData)]
self.config.project.typedAudiences = try! OTUtils.model(from: sampleRolloutTypedAudiencesData)
featureFlag.rolloutId = kRolloutId
self.config.project.featureFlags = [featureFlag]

let variation = self.decisionService.getVariationForFeatureRollout(config: config,
featureFlag: featureFlag,
userId: kUserId,
attributes: kAttributesEmpty)
XCTAssert(variation!.key == kVariationKeyA)
attributes: kAttributesRolloutAge1Match)
XCTAssert(variation!.key == kRolloutVariationKeyA)
}

func testGetVariationForFeatureRolloutEmpty() {
Expand All @@ -253,10 +327,63 @@ extension DecisionServiceTests_Features {
XCTAssertNil(variation)
}

func testGetVariationForFeatureRolloutMultiple() {
// add tests for last rollout handling
func testGetVariationForFeatureRolloutFallbackRule() {
self.config.project.rollouts = [try! OTUtils.model(from: sampleRolloutData)]
self.config.project.typedAudiences = try! OTUtils.model(from: sampleRolloutTypedAudiencesData)
self.config.project.rollouts[0].experiments[0].trafficAllocation[0].endOfRange = 0
featureFlag.rolloutId = kRolloutId
self.config.project.featureFlags = [featureFlag]

let variation = self.decisionService.getVariationForFeatureRollout(config: config,
featureFlag: featureFlag,
userId: kUserId,
attributes: kAttributesRolloutAge1Match)
XCTAssert(variation!.key == kRolloutVariationKeyC)
}

func testGetVariationForFeatureRolloutEvaluatesNextIfAudienceEvaluationFails() {
self.config.project.rollouts = [try! OTUtils.model(from: sampleRolloutData)]
self.config.project.typedAudiences = try! OTUtils.model(from: sampleRolloutTypedAudiencesData)
featureFlag.rolloutId = kRolloutId
self.config.project.featureFlags = [featureFlag]

let variation = self.decisionService.getVariationForFeatureRollout(config: config,
featureFlag: featureFlag,
userId: kUserId,
attributes: kAttributesRolloutAge2Match)
XCTAssert(variation!.key == kRolloutVariationKeyB)
}

func testGetVariationForFeatureRolloutReturnsNilIfAudienceEvaluationFailsForFallback() {
self.config.project.rollouts = [try! OTUtils.model(from: sampleRolloutData)]
self.config.project.typedAudiences = try! OTUtils.model(from: sampleRolloutTypedAudiencesData)
featureFlag.rolloutId = kRolloutId
self.config.project.featureFlags = [featureFlag]

self.config.project.rollouts[0].experiments[0].audienceIds = [kRolloutAudienceIdAge2]
self.config.project.rollouts[0].experiments[0].trafficAllocation[0].endOfRange = 0
self.config.project.rollouts[0].experiments[2].audienceIds = [kRolloutAudienceIdAge1]
let variation = self.decisionService.getVariationForFeatureRollout(config: config,
featureFlag: featureFlag,
userId: kUserId,
attributes: kAttributesRolloutAge2Match)
XCTAssertNil(variation)
}

func testGetVariationForFeatureRolloutReturnsNilIfBucketingFailsForFallback() {
self.config.project.rollouts = [try! OTUtils.model(from: sampleRolloutData)]
self.config.project.typedAudiences = try! OTUtils.model(from: sampleRolloutTypedAudiencesData)
featureFlag.rolloutId = kRolloutId
self.config.project.featureFlags = [featureFlag]

self.config.project.rollouts[0].experiments[0].trafficAllocation[0].endOfRange = 0
self.config.project.rollouts[0].experiments[2].trafficAllocation[0].endOfRange = 0
let variation = self.decisionService.getVariationForFeatureRollout(config: config,
featureFlag: featureFlag,
userId: kUserId,
attributes: kAttributesRolloutAge1Match)
XCTAssertNil(variation)
}
}

// MARK: - Test getVariationForFeatureERollout()
Expand Down Expand Up @@ -293,7 +420,7 @@ extension DecisionServiceTests_Features {
attributes: kAttributesCountryNotMatch)
XCTAssertNotNil(pair)
XCTAssertNil(pair!.experiment)
XCTAssert(pair!.variation!.key == kVariationKeyA)
XCTAssert(pair!.variation!.key == kRolloutVariationKeyC)
}

}