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.

Author: mfahadahmed

OptimizelySDK.Tests/OptimizelyTest.cs

@@ -1812,5 +1812,51 @@ public void TestGetEnabledFeaturesWithSomeFeaturesEnabledForUser()
         }
 
         #endregion // Test GetEnabledFeatures
+
+        #region Test ValidateStringInputs
+
+        [Test]
+        public void TestActivateValidateInputValues()
+        {
+            // 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 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);
+        }
+
+        [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/Optimizely.cs

@@ -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;
@@ -595,5 +626,25 @@ public List<string> GetEnabledFeatures(string userId, UserAttributes userAttribu
         }
 
         #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;
+        }
     }
 }