Skip to content

Refact: Refactored Forced decision #287

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.

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 14 commits into from
Dec 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions OptimizelySDK.Net35/OptimizelySDK.Net35.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,9 @@
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisionContext.cs">
<Link>OptimizelyDecisionContext.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\ForcedDecisionsStore.cs">
<Link>ForcedDecisionsStore.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyForcedDecision.cs">
<Link>OptimizelyForcedDecision.cs</Link>
Expand Down
3 changes: 3 additions & 0 deletions OptimizelySDK.Net40/OptimizelySDK.Net40.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,9 @@
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisionContext.cs">
<Link>OptimizelyDecisionContext.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\ForcedDecisionsStore.cs">
<Link>ForcedDecisionsStore.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyForcedDecision.cs">
<Link>OptimizelyForcedDecision.cs</Link>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@
<Compile Include="..\OptimizelySDK\OptimizelyUserContext.cs" />
<Compile Include="..\OptimizelySDK\Config\FallbackProjectConfigManager.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyDecisionContext.cs" />
<Compile Include="..\OptimizelySDK\ForcedDecisionsStore.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyForcedDecision.cs">
<Link>OptimizelyForcedDecision.cs</Link>
</Compile>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,9 @@
<Compile Include="..\OptimizelySDK\OptimizelyDecisionContext.cs">
<Link>OptimizelyDecisionContext.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\ForcedDecisionsStore.cs">
<Link>ForcedDecisionsStore.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyForcedDecision.cs">
<Link>OptimizelyForcedDecision.cs</Link>
</Compile>
Expand Down
29 changes: 14 additions & 15 deletions OptimizelySDK.Tests/DecisionServiceTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ public void TestGetVariationForcedVariationPrecedesAudienceEval()
OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, new UserAttributes(), ErrorHandlerMock.Object, LoggerMock.Object);
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(GenericUserId);
// user excluded without audiences and whitelisting
Assert.IsNull(decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes()).ResultObject);
Assert.IsNull(decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig).ResultObject);

OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(WhitelistedUserId);
var actualVariation = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes());
var actualVariation = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig);

LoggerMock.Verify(l => l.Log(LogLevel.INFO, string.Format("User \"{0}\" is forced in variation \"vtag5\".", WhitelistedUserId)), Times.Once);

Expand All @@ -110,7 +110,7 @@ public void TestGetVariationLogsErrorWhenUserProfileMapItsNull()
var options = new OptimizelyDecideOption[] { OptimizelyDecideOption.INCLUDE_REASONS };
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(GenericUserId);

var variationResult = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes(), options);
var variationResult = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, options);
Assert.AreEqual(variationResult.DecisionReasons.ToReport(true)[0], "We were unable to get a user profile map from the UserProfileService.");
Assert.AreEqual(variationResult.DecisionReasons.ToReport(true)[1], "Audiences for experiment \"etag3\" collectively evaluated to FALSE");
Assert.AreEqual(variationResult.DecisionReasons.ToReport(true)[2], "User \"genericUserId\" does not meet conditions to be in experiment \"etag3\".");
Expand All @@ -136,15 +136,15 @@ public void TestGetVariationEvaluatesUserProfileBeforeAudienceTargeting()

DecisionService decisionService = new DecisionService(BucketerMock.Object, ErrorHandlerMock.Object, UserProfileServiceMock.Object, LoggerMock.Object);

decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes());
decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig);

LoggerMock.Verify(l => l.Log(LogLevel.INFO, string.Format("User \"{0}\" does not meet conditions to be in experiment \"{1}\".",
GenericUserId, experiment.Key)), Times.Once);

OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(UserProfileId);

// ensure that a user with a saved user profile, sees the same variation regardless of audience evaluation
decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes());
decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig);

BucketerMock.Verify(_ => _.Bucket(It.IsAny<ProjectConfig>(), It.IsAny<Experiment>(), It.IsAny<string>(), It.IsAny<string>()), Times.Never);
}
Expand Down Expand Up @@ -234,7 +234,7 @@ public void TestBucketReturnsVariationStoredInUserProfile()
OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, new UserAttributes(), ErrorHandlerMock.Object, LoggerMock.Object);
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(UserProfileId);

var actualVariation = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes());
var actualVariation = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig);

Assertions.AreEqual(variation, actualVariation.ResultObject);

Expand Down Expand Up @@ -316,7 +316,7 @@ public void TestGetVariationSavesBucketedVariationIntoUserProfile()

OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(UserProfileId);

Assert.IsTrue(TestData.CompareObjects(variation.ResultObject, decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes()).ResultObject));
Assert.IsTrue(TestData.CompareObjects(variation.ResultObject, decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig).ResultObject));

LoggerMock.Verify(l => l.Log(LogLevel.INFO, string.Format("Saved variation \"{0}\" of experiment \"{1}\" for user \"{2}\".", variation.ResultObject.Id,
experiment.Id, UserProfileId)), Times.Once);
Expand Down Expand Up @@ -374,7 +374,7 @@ public void TestGetVariationSavesANewUserProfile()
UserProfileServiceMock.Object, LoggerMock.Object);
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(UserProfileId);

var actualVariation = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, new UserAttributes());
var actualVariation = decisionService.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig);

Assertions.AreEqual(variation.ResultObject, actualVariation.ResultObject);

Expand Down Expand Up @@ -578,12 +578,12 @@ public void TestGetVariationForFeatureExperimentGivenNonMutexGroupAndUserIsBucke

var optlyObject = new Optimizely(TestData.Datafile, new ValidEventDispatcher(), LoggerMock.Object);

OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, new UserAttributes(), ErrorHandlerMock.Object, LoggerMock.Object);
OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, userAttributes, ErrorHandlerMock.Object, LoggerMock.Object);

OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns("user1");

DecisionServiceMock.Setup(ds => ds.GetVariation(ProjectConfig.GetExperimentFromKey("test_experiment_multivariate"),
OptimizelyUserContextMock.Object, ProjectConfig, userAttributes, It.IsAny<OptimizelyDecideOption[]>())).Returns(variation);
OptimizelyUserContextMock.Object, ProjectConfig, It.IsAny<OptimizelyDecideOption[]>())).Returns(variation);

var featureFlag = ProjectConfig.GetFeatureFlagFromKey("multi_variate_feature");
var decision = DecisionServiceMock.Object.GetVariationForFeatureExperiment(featureFlag, OptimizelyUserContextMock.Object, userAttributes, ProjectConfig, new OptimizelyDecideOption[] { });
Expand All @@ -604,11 +604,10 @@ public void TestGetVariationForFeatureExperimentGivenMutexGroupAndUserIsBucketed

var optlyObject = new Optimizely(TestData.Datafile, new ValidEventDispatcher(), LoggerMock.Object);

OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, new UserAttributes(), ErrorHandlerMock.Object, LoggerMock.Object);
OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, userAttributes, ErrorHandlerMock.Object, LoggerMock.Object);
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns("user1");

DecisionServiceMock.Setup(ds => ds.GetVariation(ProjectConfig.GetExperimentFromKey("group_experiment_1"), OptimizelyUserContextMock.Object, ProjectConfig,
userAttributes)).Returns(variation);
DecisionServiceMock.Setup(ds => ds.GetVariation(ProjectConfig.GetExperimentFromKey("group_experiment_1"), OptimizelyUserContextMock.Object, ProjectConfig)).Returns(variation);

var featureFlag = ProjectConfig.GetFeatureFlagFromKey("boolean_feature");
var actualDecision = DecisionServiceMock.Object.GetVariationForFeatureExperiment(featureFlag, OptimizelyUserContextMock.Object, userAttributes, ProjectConfig, new OptimizelyDecideOption[] { });
Expand All @@ -625,7 +624,7 @@ public void TestGetVariationForFeatureExperimentGivenMutexGroupAndUserNotBuckete
var mutexExperiment = ProjectConfig.GetExperimentFromKey("group_experiment_1");
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns("user1");

DecisionServiceMock.Setup(ds => ds.GetVariation(It.IsAny<Experiment>(), It.IsAny<OptimizelyUserContext>(), ProjectConfig, It.IsAny<UserAttributes>(), It.IsAny<OptimizelyDecideOption[]>()))
DecisionServiceMock.Setup(ds => ds.GetVariation(It.IsAny<Experiment>(), It.IsAny<OptimizelyUserContext>(), ProjectConfig, It.IsAny<OptimizelyDecideOption[]>()))
.Returns(Result<Variation>.NullResult(null));

var featureFlag = ProjectConfig.GetFeatureFlagFromKey("boolean_feature");
Expand Down Expand Up @@ -975,7 +974,7 @@ public void TestGetVariationForFeatureWhenTheUserIsBuckedtedInBothExperimentAndR
OptimizelyUserContextMock = new Mock<OptimizelyUserContext>(optlyObject, WhitelistedUserId, userAttributes, ErrorHandlerMock.Object, LoggerMock.Object);
OptimizelyUserContextMock.Setup(ouc => ouc.GetUserId()).Returns(UserProfileId);

DecisionServiceMock.Setup(ds => ds.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, userAttributes, It.IsAny<OptimizelyDecideOption[]>())).Returns(variation);
DecisionServiceMock.Setup(ds => ds.GetVariation(experiment, OptimizelyUserContextMock.Object, ProjectConfig, It.IsAny<OptimizelyDecideOption[]>())).Returns(variation);
var actualDecision = DecisionServiceMock.Object.GetVariationForFeatureExperiment(featureFlag, OptimizelyUserContextMock.Object, userAttributes, ProjectConfig, new OptimizelyDecideOption[] { });

// The user is bucketed into feature experiment's variation.
Expand Down
123 changes: 123 additions & 0 deletions OptimizelySDK.Tests/ForcedDecisionsStoreTest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/**
*
* Copyright 2021, Optimizely and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using NUnit.Framework;

namespace OptimizelySDK.Tests
{
[TestFixture]
public class ForcedDecisionsStoreTest
{
[Test]
public void ForcedDecisionStoreGetSetForcedDecisionWithBothRuleAndFlagKey()
{
var expectedForcedDecision1 = new OptimizelyForcedDecision("sample_variation_key");
var expectedForcedDecision2 = new OptimizelyForcedDecision("sample_variation_key_2");
var context1 = new OptimizelyDecisionContext("flag_key", "rule_key");
var context2 = new OptimizelyDecisionContext("flag_key", "rule_key1");
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context1] = expectedForcedDecision1;
forcedDecisionStore[context2] = expectedForcedDecision2;

Assert.AreEqual(forcedDecisionStore.Count, 2);
Assert.AreEqual(forcedDecisionStore[context1].VariationKey, expectedForcedDecision1.VariationKey);
Assert.AreEqual(forcedDecisionStore[context2].VariationKey, expectedForcedDecision2.VariationKey);
}

[Test]
public void ForcedDecisionStoreNullFlagKeyForcedDecisionContext()
{
var expectedForcedDecision = new OptimizelyForcedDecision("sample_variation_key");
var context = new OptimizelyDecisionContext(null, "rule_key");
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context] = expectedForcedDecision;

Assert.AreEqual(forcedDecisionStore.Count, 0);
}

[Test]
public void ForcedDecisionStoreNullContextForcedDecisionContext()
{
var expectedForcedDecision = new OptimizelyForcedDecision("sample_variation_key");
OptimizelyDecisionContext context = null;
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context] = expectedForcedDecision;

Assert.AreEqual(forcedDecisionStore.Count, 0);
}

[Test]
public void ForcedDecisionStoreGetForcedDecisionWithBothRuleAndFlagKey()
{
var expectedForcedDecision1 = new OptimizelyForcedDecision("sample_variation_key");
var context1 = new OptimizelyDecisionContext("flag_key", "rule_key");
var NullFlagKeyContext = new OptimizelyDecisionContext(null, "rule_key");
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context1] = expectedForcedDecision1;

Assert.AreEqual(forcedDecisionStore.Count, 1);
Assert.AreEqual(forcedDecisionStore[context1].VariationKey, expectedForcedDecision1.VariationKey);
Assert.IsNull(forcedDecisionStore[NullFlagKeyContext]);
}

[Test]
public void ForcedDecisionStoreRemoveForcedDecisionTrue()
{
var expectedForcedDecision1 = new OptimizelyForcedDecision("sample_variation_key");
var expectedForcedDecision2 = new OptimizelyForcedDecision("sample_variation_key_2");
var context1 = new OptimizelyDecisionContext("flag_key", "rule_key");
var context2 = new OptimizelyDecisionContext("flag_key", "rule_key1");
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context1] = expectedForcedDecision1;
forcedDecisionStore[context2] = expectedForcedDecision2;

Assert.AreEqual(forcedDecisionStore.Count, 2);
Assert.IsTrue(forcedDecisionStore.Remove(context2));
Assert.AreEqual(forcedDecisionStore.Count, 1);
Assert.AreEqual(forcedDecisionStore[context1].VariationKey, expectedForcedDecision1.VariationKey);
Assert.IsNull(forcedDecisionStore[context2]);
}

[Test]
public void ForcedDecisionStoreRemoveForcedDecisionContextRuleKeyNotMatched()
{
var expectedForcedDecision = new OptimizelyForcedDecision("sample_variation_key");
var contextNotMatched = new OptimizelyDecisionContext("flag_key", "");
var context = new OptimizelyDecisionContext("flag_key", "rule_key");
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context] = expectedForcedDecision;

Assert.AreEqual(forcedDecisionStore.Count, 1);
Assert.IsFalse(forcedDecisionStore.Remove(contextNotMatched));
Assert.AreEqual(forcedDecisionStore.Count, 1);
}

[Test]
public void ForcedDecisionStoreRemoveAllForcedDecisionContext()
{
var expectedForcedDecision = new OptimizelyForcedDecision("sample_variation_key");
var context = new OptimizelyDecisionContext("flag_key", "rule_key");
var forcedDecisionStore = new ForcedDecisionsStore();
forcedDecisionStore[context] = expectedForcedDecision;

Assert.AreEqual(forcedDecisionStore.Count, 1);
forcedDecisionStore.RemoveAll();
Assert.AreEqual(forcedDecisionStore.Count, 0);
}

}
}
3 changes: 2 additions & 1 deletion OptimizelySDK.Tests/OptimizelySDK.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
<Compile Include="AudienceConditionsTests\ConditionsTest.cs" />
<Compile Include="ConfigTest\HttpProjectConfigManagerTest.cs" />
<Compile Include="ConfigTest\PollingProjectConfigManagerTest.cs" />
<Compile Include="ConfigTest\AtomicProjectConfigManagerTest.cs" />
<Compile Include="ConfigTest\FallbackProjectConfigManagerTest.cs" />
<Compile Include="DecisionServiceTest.cs" />
<Compile Include="DefaultErrorHandlerTest.cs" />
<Compile Include="EventTests\EventProcessorProps.cs" />
Expand All @@ -93,6 +93,7 @@
<Compile Include="NotificationTests\NotificationCenterTests.cs" />
<Compile Include="ClientConfigHandlerTest.cs" />
<Compile Include="OptimizelyTest.cs" />
<Compile Include="ForcedDecisionsStoreTest.cs" />
<Compile Include="OptimizelyUserContextTest.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="TestBucketer.cs" />
Expand Down
Loading