2.0.1 (#86)

* GetEnabledFeatures now returns sorted features list. (#69)

* GetEnabledFeatures now returns sorted features list ignoring case

* Removes sorting from GetEnabledFeatures method. (#73)

* OASIS-2504 [C#] Release 2.0.0-beta1 (#72)

* OASIS-2504 [C#] Release 2.0.0-beta1 (#71)

* Revert "Eventdispatcherissue (#35) (#54)"

This reverts commit 5df7cfb.

* Bump version to 2.0 beta.

* Update OptimizelySDK.nuspec

* AssemblyVersion = 2.0.0.0

* Improved 1.3.1 DemoApp

* Updated OptimizelySDK.Package and OptimizelySDK.nuspec

* keypair.snk for *.sln, *.csproj

* CHANGELOG.md corrections

* SDK_VERSION synch with NuGet package version.

* Make 'UserAttributes userAttributes = null' optional in 5 API's

* Update verifysn.ps1 and DemoApp.csproj to 2.0.0-beta1

* Correct 2.0.0-beta1 release date in CHANGELOG.md

* 2.0.0-beta1 --> 2.0.0 (#74) (#75)

* Input validation in Activate, Track and GetVariation methods. (#76)

* Input validation in Activate, Track and GetVariation methods.

* Replaced InputType enum with string constants.

* Updates unit tests.

* Fix impression sent from feature experiment variation toggled off.

* Revert "Fix impression sent from feature experiment variation toggled off."

This reverts commit c943747.

* Fix impression sent from feature experiment variation toggled off. (#84)

* Update OptimizelySDK.DemoApp.csproj OptimizelySDK Reference

* Update AssemblyVersion, AssemblyFileVersion, AssemblyInformationalVersion

* Update the OptimizelySDK.Package/OptimizelySDK.nuspec

* Upgrade DemoApp to OptimizelySDK 2.0.1

Author: kellyroach-optimizely

OptimizelySDK.DemoApp/OptimizelySDK.DemoApp.csproj

@@ -128,7 +128,7 @@
       <HintPath>..\packages\NJsonSchema.8.30.6304.31883\lib\net45\NJsonSchema.dll</HintPath>
     </Reference>
     <Reference Include="OptimizelySDK">
-      <HintPath>..\packages\Optimizely.SDK.2.0.0-beta1\lib\net45\OptimizelySDK.dll</HintPath>
+      <HintPath>..\packages\Optimizely.SDK.2.0.1\lib\net45\OptimizelySDK.dll</HintPath>
     </Reference>
   </ItemGroup>
   <ItemGroup>

OptimizelySDK.DemoApp/Properties/AssemblyInfo.cs

@@ -37,6 +37,6 @@
 //
 // You can specify all the values or you can default the Revision and Build Numbers
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
-[assembly: AssemblyInformationalVersion("2.0.0")] // Used by Nuget.
+[assembly: AssemblyVersion("2.0.1.0")]
+[assembly: AssemblyFileVersion("2.0.1.0")]
+[assembly: AssemblyInformationalVersion("2.0.1")] // Used by Nuget.

OptimizelySDK.DemoApp/packages.config

@@ -18,7 +18,7 @@
   <package id="murmurhash-signed" version="1.0.2" targetFramework="net45" />
   <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net45" />
   <package id="NJsonSchema" version="8.30.6304.31883" targetFramework="net45" />
-  <package id="Optimizely.SDK" version="2.0.0" targetFramework="net45" />
+  <package id="Optimizely.SDK" version="2.0.1" targetFramework="net45" />
   <package id="popper.js" version="1.12.9" targetFramework="net45" />
   <package id="Respond" version="1.2.0" targetFramework="net45" />
   <package id="WebGrease" version="1.5.2" targetFramework="net45" />

OptimizelySDK.Net35/Properties/AssemblyInfo.cs

@@ -38,6 +38,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
-[assembly: AssemblyInformationalVersion("2.0.0")] // Used by Nuget.
+[assembly: AssemblyVersion("2.0.1.0")]
+[assembly: AssemblyFileVersion("2.0.1.0")]
+[assembly: AssemblyInformationalVersion("2.0.1")] // Used by Nuget.

OptimizelySDK.Net40/Properties/AssemblyInfo.cs

@@ -38,6 +38,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
-[assembly: AssemblyInformationalVersion("2.0.0")] // Used by Nuget.
+[assembly: AssemblyVersion("2.0.1.0")]
+[assembly: AssemblyFileVersion("2.0.1.0")]
+[assembly: AssemblyInformationalVersion("2.0.1")] // Used by Nuget.

OptimizelySDK.Package/OptimizelySDK.nuspec

@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <package>
     <metadata>
         <id>Optimizely.SDK</id>
-        <version>2.0.0</version>
+        <version>2.0.1</version>
         <title>Optimizely C# SDK</title>
         <authors>Optimizely Development Team</authors>
         <owners>fullstack.optimizely</owners>

OptimizelySDK.Tests/OptimizelyTest.cs

@@ -38,6 +38,7 @@ public class OptimizelyTest
         private ProjectConfig Config;
         private Mock<EventBuilder> EventBuilderMock;
         private Mock<IErrorHandler> ErrorHandlerMock;
+        private Mock<IEventDispatcher> EventDispatcherMock;
         private Optimizely Optimizely;
         private IEventDispatcher EventDispatcher;
         private const string TestUserId = "testUserId";
@@ -73,19 +74,19 @@ public void Initialize()
                 logger: LoggerMock.Object,
                 errorHandler: new NoOpErrorHandler());
 
-            EventDispatcher = new ValidEventDispatcher();
-            Optimizely = new Optimizely(TestData.Datafile, EventDispatcher, LoggerMock.Object, ErrorHandlerMock.Object);
+            EventDispatcherMock = new Mock<IEventDispatcher>();
+            Optimizely = new Optimizely(TestData.Datafile, EventDispatcherMock.Object, LoggerMock.Object, ErrorHandlerMock.Object);
 
             Helper = new OptimizelyHelper
             {
                 Datafile = TestData.Datafile,
-                EventDispatcher = EventDispatcher,
+                EventDispatcher = EventDispatcherMock.Object,
                 Logger = LoggerMock.Object,
                 ErrorHandler = ErrorHandlerMock.Object,
                 SkipJsonValidation = false,
             };
 
-            OptimizelyMock = new Mock<Optimizely>(TestData.Datafile, EventDispatcher, LoggerMock.Object, ErrorHandlerMock.Object, null, false)
+            OptimizelyMock = new Mock<Optimizely>(TestData.Datafile, EventDispatcherMock.Object, LoggerMock.Object, ErrorHandlerMock.Object, null, false)
             {
                 CallBase = true
             };
@@ -1539,6 +1540,34 @@ public void TestIsFeatureEnabledGivenFeatureFlagIsEnabledAndUserIsBeingExperimen
                 $@"Feature flag ""{featureKey}"" is enabled for user ""{TestUserId}""."));
         }
 
+        // Should return false and send an impression event when feature is enabled for the user 
+        // and user is being experimented.
+        [Test]
+        public void TestIsFeatureEnabledGivenFeatureFlagIsNotEnabledAndUserIsBeingExperimented()
+        {
+            var featureKey = "double_single_variable_feature";
+            var experiment = Config.GetExperimentFromKey("test_experiment_double_feature");
+            var variation = Config.GetVariationFromKey("test_experiment_double_feature", "variation");
+            var featureFlag = Config.GetFeatureFlagFromKey(featureKey);
+            var decision = new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_EXPERIMENT);
+
+            DecisionServiceMock.Setup(ds => ds.GetVariationForFeature(featureFlag, TestUserId, null)).Returns(decision);
+
+            var optly = Helper.CreatePrivateOptimizely();
+            optly.SetFieldOrProperty("DecisionService", DecisionServiceMock.Object);
+
+            bool result = (bool)optly.Invoke("IsFeatureEnabled", featureKey, TestUserId, null);
+            Assert.False(result);
+
+            // SendImpressionEvent() gets called.
+            LoggerMock.Verify(l => l.Log(LogLevel.INFO,
+                $@"The user ""{TestUserId}"" is not being experimented on feature ""{featureKey}""."), Times.Never);
+
+            LoggerMock.Verify(l => l.Log(LogLevel.INFO,
+                $@"Feature flag ""{featureKey}"" is not enabled for user ""{TestUserId}""."));
+            EventDispatcherMock.Verify(dispatcher => dispatcher.DispatchEvent(It.IsAny<LogEvent>()));
+        }
+
         // Verify that IsFeatureEnabled returns true if a variation does not get found in the feature
         // flag experiment but found in the rollout rule.
         [Test]
@@ -1811,36 +1840,52 @@ public void TestGetEnabledFeaturesWithSomeFeaturesEnabledForUser()
             Array.ForEach(notEnabledFeatures, nef => CollectionAssert.DoesNotContain(actualFeaturesList, nef));
         }
 
+        #endregion // Test GetEnabledFeatures
+
+        #region Test ValidateStringInputs
+
         [Test]
-        public void TestGetEnabledFeaturesReturnsSortedList()
+        public void TestActivateValidateInputValues()
         {
-            string[] unsortedFeaturesList =
-            {
-                 "double_single_variable_feature",
-                 "boolean_feature",
-                 "string_single_variable_feature",
-                 "multi_variate_feature",
-                 "empty_feature",
-                 "boolean_single_variable_feature"
-             };
-            string[] sortedFeaturesList =
-            {
-                 "boolean_feature",
-                 "boolean_single_variable_feature",
-                 "double_single_variable_feature",
-                 "empty_feature",
-                 "multi_variate_feature",
-                 "string_single_variable_feature",
-             };
-
-            OptimizelyMock.Setup(om => om.IsFeatureEnabled(It.IsIn<string>(unsortedFeaturesList), TestUserId,
-                It.IsAny<UserAttributes>())).Returns(true);
+            // Verify that ValidateStringInputs does not log error for valid values.
+            var variation = Optimizely.Activate("test_experiment", "test_user");
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided User Id is in invalid format."), Times.Never);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided Experiment Key is in invalid format."), Times.Never);
 
-            // Verify that returned list in sorterd in ascending order.
-            var actualFeaturesList = OptimizelyMock.Object.GetEnabledFeatures(TestUserId, null);
-            CollectionAssert.AreEqual(sortedFeaturesList, actualFeaturesList);
+            // Verify that ValidateStringInputs logs error for invalid values.
+            variation = Optimizely.Activate("", null);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided User Id is in invalid format."), Times.Once);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided Experiment Key is in invalid format."), Times.Once);
         }
 
-        #endregion // Test GetEnabledFeatures
+        [Test]
+        public void TestGetVariationValidateInputValues()
+        {
+            // Verify that ValidateStringInputs does not log error for valid values.
+            var variation = Optimizely.GetVariation("test_experiment", "test_user");
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided User Id is in invalid format."), Times.Never);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided Experiment Key is in invalid format."), Times.Never);
+
+            // Verify that ValidateStringInputs logs error for invalid values.
+            variation = Optimizely.GetVariation("", null);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided User Id is in invalid format."), Times.Once);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided Experiment Key is in invalid format."), Times.Once);
+        }
+
+        [Test]
+        public void TestTrackValidateInputValues()
+        {
+            // Verify that ValidateStringInputs does not log error for valid values.
+            Optimizely.Track("purchase", "test_user");
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided User Id is in invalid format."), Times.Never);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided Event Key is in invalid format."), Times.Never);
+
+            // Verify that ValidateStringInputs logs error for invalid values.
+            Optimizely.Track("", null);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided User Id is in invalid format."), Times.Once);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided Event Key is in invalid format."), Times.Once);
+        }
+
+        #endregion // Test ValidateStringInputs
     }
 }

OptimizelySDK.Tests/Properties/AssemblyInfo.cs

@@ -31,6 +31,6 @@
 //
 // You can specify all the values or you can default the Revision and Build Numbers
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
-[assembly: AssemblyInformationalVersion("2.0.0")] // Used by Nuget.
+[assembly: AssemblyVersion("2.0.1.0")]
+[assembly: AssemblyFileVersion("2.0.1.0")]
+[assembly: AssemblyInformationalVersion("2.0.1")] // Used by Nuget.

OptimizelySDK/Optimizely.cs

@@ -51,7 +51,7 @@ public class Optimizely
 
         public static String SDK_VERSION {
             get {
-                // Example output: "2.0.0" .  Should be kept in synch with NuGet package version.
+                // Example output: "2.0.1" .  Should be kept in synch with NuGet package version.
 #if NET35
                 Assembly assembly = Assembly.GetExecutingAssembly();
 #else
@@ -71,6 +71,10 @@ public static String SDK_TYPE {
             }
         }
 
+        public const string USER_ID = "User Id";
+        public const string EXPERIMENT_KEY = "Experiment Key";
+        public const string EVENT_KEY = "Event Key";
+
         /// <summary>
         /// Optimizely constructor for managing Full Stack .NET projects.
         /// </summary>
@@ -158,6 +162,15 @@ public Variation Activate(string experimentKey, string userId, UserAttributes us
                 return null;
             }
 
+            var inputValues = new Dictionary<string, string>
+            {
+                { USER_ID, userId },
+                { EXPERIMENT_KEY, experimentKey }
+            };
+
+            if (!ValidateStringInputs(inputValues))
+                return null;
+
             var experiment = Config.GetExperimentFromKey(experimentKey);
 
             if (experiment.Key == null)
@@ -210,6 +223,15 @@ public void Track(string eventKey, string userId, UserAttributes userAttributes
                 return;
             }
 
+            var inputValues = new Dictionary<string, string>
+            {
+                { USER_ID, userId },
+                { EVENT_KEY, eventKey }
+            };
+
+            if (!ValidateStringInputs(inputValues))
+                return;
+
             var eevent = Config.GetEvent(eventKey);
 
             if (eevent.Key == null)
@@ -290,6 +312,15 @@ public Variation GetVariation(string experimentKey, string userId, UserAttribute
                 return null;
             }
 
+            var inputValues = new Dictionary<string, string>
+            {
+                { USER_ID, userId },
+                { EXPERIMENT_KEY, experimentKey }
+            };
+
+            if (!ValidateStringInputs(inputValues))
+                return null;
+
             Experiment experiment = Config.GetExperimentFromKey(experimentKey);
             if (experiment.Key == null)
                 return null;
@@ -335,14 +366,12 @@ public Variation GetForcedVariation(string experimentKey, string userId)
         /// <returns>True if feature is enabled, false or null otherwise</returns>
         public virtual bool IsFeatureEnabled(string featureKey, string userId, UserAttributes userAttributes = null)
         {
-            if (string.IsNullOrEmpty(userId))
-            {
+            if (string.IsNullOrEmpty(userId)) {
                 Logger.Log(LogLevel.ERROR, "User ID must not be empty.");
                 return false;
             }
 
-            if (string.IsNullOrEmpty(featureKey))
-            {
+            if (string.IsNullOrEmpty(featureKey)) {
                 Logger.Log(LogLevel.ERROR, "Feature flag key must not be empty.");
                 return false;
             }
@@ -355,19 +384,21 @@ public virtual bool IsFeatureEnabled(string featureKey, string userId, UserAttri
                 return false;
 
             var decision = DecisionService.GetVariationForFeature(featureFlag, userId, userAttributes);
-            if (decision == null || !decision.Variation.IsFeatureEnabled)
-            {
-                Logger.Log(LogLevel.INFO, $@"Feature flag ""{featureKey}"" is not enabled for user ""{userId}"".");
-                return false;
+            if (decision != null) {
+                if (decision.Source == FeatureDecision.DECISION_SOURCE_EXPERIMENT) {
+                    SendImpressionEvent(decision.Experiment, decision.Variation, userId, userAttributes);
+                } else {
+                    Logger.Log(LogLevel.INFO, $@"The user ""{userId}"" is not being experimented on feature ""{featureKey}"".");
+                }
+                if (decision.Variation.IsFeatureEnabled) {
+                    Logger.Log(LogLevel.INFO, $@"Feature flag ""{featureKey}"" is enabled for user ""{userId}"".");
+                    return true;
+                }
             }
 
-            if (decision.Source == FeatureDecision.DECISION_SOURCE_EXPERIMENT)
-                SendImpressionEvent(decision.Experiment, decision.Variation, userId, userAttributes);
-            else
-                Logger.Log(LogLevel.INFO, $@"The user ""{userId}"" is not being experimented on feature ""{featureKey}"".");
 
-            Logger.Log(LogLevel.INFO, $@"Feature flag ""{featureKey}"" is enabled for user ""{userId}"".");
-            return true;
+            Logger.Log(LogLevel.INFO, $@"Feature flag ""{featureKey}"" is not enabled for user ""{userId}"".");
+            return false;
         }
 
         /// <summary>
@@ -591,11 +622,29 @@ public List<string> GetEnabledFeatures(string userId, UserAttributes userAttribu
                     enabledFeaturesList.Add(featureKey);
             }
 
-            enabledFeaturesList.Sort();
-
             return enabledFeaturesList;
         }
 
         #endregion // FeatureFlag APIs
+
+        /// <summary>
+        /// Validate all string inputs are not null or empty.
+        /// </summary>
+        /// <param name="inputs">Array Hash input types and values</param>
+        /// <returns>True if all values are valid, false otherwise</returns>
+        private bool ValidateStringInputs(Dictionary<string, string> inputs)
+        {
+            bool isValid = true;
+            foreach(var input in inputs)
+            {
+                if (string.IsNullOrEmpty(input.Value))
+                {
+                    Logger.Log(LogLevel.ERROR, $"Provided {input.Key} is in invalid format.");
+                    isValid = false;
+                }
+            }
+
+            return isValid;
+        }
     }
 }

OptimizelySDK/Properties/AssemblyInfo.cs

@@ -38,6 +38,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
-[assembly: AssemblyInformationalVersion("2.0.0")] // Used by Nuget.
+[assembly: AssemblyVersion("2.0.1.0")]
+[assembly: AssemblyFileVersion("2.0.1.0")]
+[assembly: AssemblyInformationalVersion("2.0.1")] // Used by Nuget.