Feat(decide): Added UserContext and reason logs

OptimizelySDK.Tests/BucketerTest.cs

@@ -19,6 +19,7 @@
 using OptimizelySDK.Config;
 using OptimizelySDK.Entity;
 using OptimizelySDK.Logger;
+using OptimizelySDK.OptimizelyDecisions;
 
 namespace OptimizelySDK.Tests
 {
@@ -27,6 +28,7 @@ public class BucketerTest
     {
         private Mock<ILogger> LoggerMock;
         private ProjectConfig Config;
+        private IDecisionReasons DecisionReasons;
         private const string TestUserId = "testUserId";
         public string TestBucketingIdControl { get; } = "testBucketingIdControl!"; // generates bucketing number 3741
         public string TestBucketingIdVariation { get; } = "123456789'"; // generates bucketing number 4567
@@ -59,6 +61,7 @@ public override string ToString()
         public void Initialize()
         {
             LoggerMock = new Mock<ILogger>();
+            DecisionReasons = DefaultDecisionReasons.NewInstance();
             Config = DatafileProjectConfig.Create(TestData.Datafile, LoggerMock.Object, new ErrorHandler.NoOpErrorHandler());
         }
 
@@ -95,42 +98,41 @@ public void TestBucketValidExperimentNotInGroup()
         {
             TestBucketer bucketer = new TestBucketer(LoggerMock.Object);
             bucketer.SetBucketValues(new[] { 3000, 7000, 9000 });
-
             // 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, DecisionReasons));
 
             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, DecisionReasons));
 
             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, DecisionReasons));
 
             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!]."));
             LoggerMock.Verify(l => l.Log(LogLevel.INFO, "User [testUserId] is in no variation."));
+            Assert.AreEqual(DecisionReasons.ToReport().Count, 0);
         }
 
         [Test]
         public void TestBucketValidExperimentInGroup()
         {
             TestBucketer bucketer = new TestBucketer(LoggerMock.Object);
-
+            
             // group_experiment_1 (20% experiment)
             // 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, DecisionReasons));
             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!]."));
@@ -139,7 +141,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, DecisionReasons));
             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!]."));
@@ -148,20 +150,21 @@ 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, DecisionReasons));
             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]."));
 
             LoggerMock.Verify(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()), Times.Exactly(10));
+            Assert.AreEqual(DecisionReasons.ToReport().Count, 0);
         }
 
         [Test]
         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, DecisionReasons));
 
             LoggerMock.Verify(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()), Times.Never);
         }
@@ -176,7 +179,8 @@ 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, DecisionReasons));
+            Assert.AreEqual(DecisionReasons.ToReport().Count, 0);
         }
 
         // Test for invalid experiment keys, null variation should be returned
@@ -187,7 +191,8 @@ 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, DecisionReasons));
+            Assert.AreEqual(DecisionReasons.ToReport().Count, 0);
         }
 
         // Make sure that the bucketing ID is used to bucket the user into a group and not the user ID
@@ -200,7 +205,8 @@ public void TestBucketVariationGroupedExperimentsWithBucketingId()
 
             Assert.AreEqual(expectedGroupVariation,
                 bucketer.Bucket(Config, Config.GetExperimentFromKey("group_experiment_2"), 
-                TestBucketingIdGroupExp2Var2, TestUserIdBucketsToNoGroup));
+                TestBucketingIdGroupExp2Var2, TestUserIdBucketsToNoGroup, DecisionReasons));
+            Assert.AreEqual(DecisionReasons.ToReport().Count, 0);
         }
 
         // Make sure that user gets bucketed into the rollout rule.
@@ -213,7 +219,8 @@ 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, DecisionReasons)));
+            Assert.AreEqual(DecisionReasons.ToReport().Count, 0);
         }
     }
-}
+}