Skip to content

Feat(decide): Added UserContext and reason logs #250

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 29 commits into from
Dec 9, 2020
Merged

Feat(decide): Added UserContext and reason logs #250

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
01bad8f
Added OptimizelyUserContext and basic functionalities
mnoman09 Nov 5, 2020
35c5e76
Added DecisionTests
mnoman09 Nov 6, 2020
f79974c
Added classes of optimizelyDecision in net35 file
mnoman09 Nov 6, 2020
7531f3c
Updated decisionmessage class and added decisionMessage test
mnoman09 Nov 6, 2020
f006b08
Added OptimizelyDecisionTest
mnoman09 Nov 9, 2020
ac0c6a5
Added CreateUserContext in Optimizely
mnoman09 Nov 9, 2020
6c9ac4d
Added UserContext add reason logs
mnoman09 Nov 11, 2020
9e36946
Revert "Added UserContext add reason logs"
mnoman09 Nov 11, 2020
8c78330
Added UserContext add reason logs
mnoman09 Nov 11, 2020
591c770
Replaced list of reasons to array.
mnoman09 Nov 13, 2020
f644b24
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Nov 13, 2020
ad77477
Merge remote-tracking branch 'origin/master' into mnoman/user-context
mnoman09 Nov 13, 2020
bab871e
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Nov 13, 2020
055bb93
Resolved comments of adding null check before reasons
mnoman09 Nov 13, 2020
5ce1419
removed underscores
mnoman09 Nov 13, 2020
1e388b7
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Nov 13, 2020
1163cde
Merge branch 'master' into mnoman/user-context
mnoman09 Nov 18, 2020
6330750
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Nov 18, 2020
fafb14c
Added Additional unit tests of optimizelyUserContext
mnoman09 Nov 24, 2020
f9d3939
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Nov 24, 2020
671aa29
added notification type flag
mnoman09 Nov 24, 2020
a0753a6
Added mutex lock in setting attributes value
mnoman09 Nov 25, 2020
0e9faa1
replaced list from array of decideOptions
mnoman09 Nov 26, 2020
4bd0b3e
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Nov 26, 2020
54e9e74
Removed unnecessary methods from errorDecisionsReasons
mnoman09 Dec 2, 2020
6934f30
Merge branch 'mnoman/user-context' into mnoman/decideapi
mnoman09 Dec 2, 2020
b824b99
Added ignoreUps check first in decision service
mnoman09 Dec 2, 2020
eda2743
Nit Fix
mnoman09 Dec 7, 2020
73cd357
Merge branch 'master' into mnoman/decideapi
mnoman09 Dec 8, 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
21 changes: 21 additions & 0 deletions OptimizelySDK.Net35/OptimizelySDK.Net35.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,27 @@
<Compile Include="..\OptimizelySDK\OptlyConfig\IOptimizelyConfigManager.cs">
<Link>OptlyConfig\IOptimizelyConfigManager.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DecisionMessage.cs">
<Link>OptimizelyDecisions\DecisionMessage.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\IDecisionReasons.cs">
<Link>OptimizelyDecisions\IDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DefaultDecisionReasons.cs">
<Link>OptimizelyDecisions\DefaultDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\ErrorsDecisionReasons.cs">
<Link>OptimizelyDecisions\ErrorsDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecideOption.cs">
<Link>OptimizelyDecisions\OptimizelyDecideOption.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecision.cs">
<Link>OptimizelyDecisions\OptimizelyDecision.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyUserContext.cs">
<Link>OptimizelyUserContext.cs</Link>
</Compile>
</ItemGroup>
<ItemGroup>
<None Include="..\OptimizelySDK\Utils\schema.json">
Expand Down
21 changes: 21 additions & 0 deletions OptimizelySDK.Net40/OptimizelySDK.Net40.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,27 @@
</Compile>
<Compile Include="..\OptimizelySDK\OptlyConfig\IOptimizelyConfigManager.cs">
<Link>OptlyConfig\IOptimizelyConfigManager.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DecisionMessage.cs">
<Link>OptimizelyDecisions\DecisionMessage.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\IDecisionReasons.cs">
<Link>OptimizelyDecisions\IDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DefaultDecisionReasons.cs">
<Link>OptimizelyDecisions\DefaultDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\ErrorsDecisionReasons.cs">
<Link>OptimizelyDecisions\ErrorsDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecideOption.cs">
<Link>OptimizelyDecisions\OptimizelyDecideOption.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecision.cs">
<Link>OptimizelyDecisions\OptimizelyDecision.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyUserContext.cs">
<Link>OptimizelyUserContext.cs</Link>
</Compile>
</ItemGroup>
<ItemGroup>
Expand Down
7 changes: 7 additions & 0 deletions OptimizelySDK.NetStandard16/OptimizelySDK.NetStandard16.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,13 @@
<Compile Include="..\OptimizelySDK\OptlyConfig\OptimizelyVariation.cs" />
<Compile Include="..\OptimizelySDK\OptlyConfig\OptimizelyConfigService.cs" />
<Compile Include="..\OptimizelySDK\OptlyConfig\IOptimizelyConfigManager.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DecisionMessage.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\IDecisionReasons.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DefaultDecisionReasons.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\ErrorsDecisionReasons.cs"/>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecideOption.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecision.cs" />
<Compile Include="..\OptimizelySDK\OptimizelyUserContext.cs" />
<Compile Include="..\OptimizelySDK\Config\FallbackProjectConfigManager.cs">
<Link>AtomicProjectConfigManager.cs</Link>
</Compile>
Expand Down
21 changes: 21 additions & 0 deletions OptimizelySDK.NetStandard20/OptimizelySDK.NetStandard20.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,27 @@
</Compile>
<Compile Include="..\OptimizelySDK\OptlyConfig\IOptimizelyConfigManager.cs">
<Link>OptlyConfig\IOptimizelyConfigManager.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DecisionMessage.cs">
<Link>OptimizelyDecisions\DecisionMessage.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\IDecisionReasons.cs">
<Link>OptimizelyDecisions\IDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\DefaultDecisionReasons.cs">
<Link>OptimizelyDecisions\DefaultDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\ErrorsDecisionReasons.cs">
<Link>OptimizelyDecisions\ErrorsDecisionReasons.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecideOption.cs">
<Link>OptimizelyDecisions\OptimizelyDecideOption.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyDecisions\OptimizelyDecision.cs">
<Link>OptimizelyDecisions\OptimizelyDecision.cs</Link>
</Compile>
<Compile Include="..\OptimizelySDK\OptimizelyUserContext.cs">
<Link>OptimizelyUserContext.cs</Link>
</Compile>
</ItemGroup>
<ItemGroup>
Expand Down
23 changes: 12 additions & 11 deletions OptimizelySDK.Tests/BucketerTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
using OptimizelySDK.Config;
using OptimizelySDK.Entity;
using OptimizelySDK.Logger;
using OptimizelySDK.OptimizelyDecisions;

namespace OptimizelySDK.Tests
{
Expand Down Expand Up @@ -98,23 +99,23 @@ public void TestBucketValidExperimentNotInGroup()

// control
Assert.AreEqual(new Variation { Id = "7722370027", Key = "control" },
bucketer.Bucket(Config, Config.GetExperimentFromKey("test_experiment"), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("test_experiment"), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));

LoggerMock.Verify(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()), Times.Exactly(2));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [3000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
LoggerMock.Verify(l => l.Log(LogLevel.INFO, "User [testUserId] is in variation [control] of experiment [test_experiment]."));

// variation
Assert.AreEqual(new Variation { Id = "7721010009", Key = "variation" },
bucketer.Bucket(Config, Config.GetExperimentFromKey("test_experiment"), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("test_experiment"), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));

LoggerMock.Verify(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()), Times.Exactly(4));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [7000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
LoggerMock.Verify(l => l.Log(LogLevel.INFO, "User [testUserId] is in variation [variation] of experiment [test_experiment]."));

// no variation
Assert.AreEqual(new Variation { },
bucketer.Bucket(Config, Config.GetExperimentFromKey("test_experiment"), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("test_experiment"), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));

LoggerMock.Verify(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()), Times.Exactly(6));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [9000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
Expand All @@ -130,7 +131,7 @@ public void TestBucketValidExperimentInGroup()
// variation 1
bucketer.SetBucketValues(new[] { 1000, 4000 });
Assert.AreEqual(new Variation { Id = "7722260071", Key = "group_exp_1_var_1" },
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_1"), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_1"), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [1000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
LoggerMock.Verify(l => l.Log(LogLevel.INFO, "User [testUserId] is in experiment [group_experiment_1] of group [7722400015]."));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [4000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
Expand All @@ -139,7 +140,7 @@ public void TestBucketValidExperimentInGroup()
// variation 2
bucketer.SetBucketValues(new[] { 1500, 7000 });
Assert.AreEqual(new Variation { Id = "7722360022", Key = "group_exp_1_var_2" },
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_1"), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_1"), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [1500] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
LoggerMock.Verify(l => l.Log(LogLevel.INFO, "User [testUserId] is in experiment [group_experiment_1] of group [7722400015]."));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [7000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
Expand All @@ -148,7 +149,7 @@ public void TestBucketValidExperimentInGroup()
// User not in experiment
bucketer.SetBucketValues(new[] { 5000, 7000 });
Assert.AreEqual(new Variation { },
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_1"), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_1"), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));
LoggerMock.Verify(l => l.Log(LogLevel.DEBUG, "Assigned bucket [5000] to user [testUserId] with bucketing ID [testBucketingIdControl!]."));
LoggerMock.Verify(l => l.Log(LogLevel.INFO, "User [testUserId] is not in experiment [group_experiment_1] of group [7722400015]."));

Expand All @@ -161,7 +162,7 @@ public void TestBucketInvalidExperiment()
var bucketer = new Bucketer(LoggerMock.Object);

Assert.AreEqual(new Variation { },
bucketer.Bucket(Config, new Experiment(), TestBucketingIdControl, TestUserId));
bucketer.Bucket(Config, new Experiment(), TestBucketingIdControl, TestUserId, DefaultDecisionReasons.NewInstance()));

LoggerMock.Verify(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()), Times.Never);
}
Expand All @@ -176,7 +177,7 @@ public void TestBucketWithBucketingId()

// make sure that the bucketing ID is used for the variation bucketing and not the user ID
Assert.AreEqual(expectedVariation,
bucketer.Bucket(Config, experiment, TestBucketingIdControl, TestUserIdBucketsToVariation));
bucketer.Bucket(Config, experiment, TestBucketingIdControl, TestUserIdBucketsToVariation, DefaultDecisionReasons.NewInstance()));
}

// Test for invalid experiment keys, null variation should be returned
Expand All @@ -187,7 +188,7 @@ public void TestBucketVariationInvalidExperimentsWithBucketingId()
var expectedVariation = new Variation();

Assert.AreEqual(expectedVariation,
bucketer.Bucket(Config, Config.GetExperimentFromKey("invalid_experiment"), TestBucketingIdVariation, TestUserId));
bucketer.Bucket(Config, Config.GetExperimentFromKey("invalid_experiment"), TestBucketingIdVariation, TestUserId, DefaultDecisionReasons.NewInstance()));
}

// Make sure that the bucketing ID is used to bucket the user into a group and not the user ID
Expand All @@ -200,7 +201,7 @@ public void TestBucketVariationGroupedExperimentsWithBucketingId()

Assert.AreEqual(expectedGroupVariation,
bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_2"),
TestBucketingIdGroupExp2Var2, TestUserIdBucketsToNoGroup));
TestBucketingIdGroupExp2Var2, TestUserIdBucketsToNoGroup, DefaultDecisionReasons.NewInstance()));
}

// Make sure that user gets bucketed into the rollout rule.
Expand All @@ -213,7 +214,7 @@ public void TestBucketRolloutRule()
var expectedVariation = Config.GetVariationFromId(rolloutRule.Key, "177773");

Assert.True(TestData.CompareObjects(expectedVariation,
bucketer.Bucket(Config, rolloutRule, "testBucketingId", TestUserId)));
bucketer.Bucket(Config, rolloutRule, "testBucketingId", TestUserId, DefaultDecisionReasons.NewInstance())));
}
}
}
Loading