Feat: Added OptimizelyJson class to support GetFeatureVariableJson

OptimizelySDK.Net35/OptimizelySDK.Net35.csproj

@@ -96,6 +96,9 @@
     </Compile>
     <Compile Include="..\OptimizelySDK\Entity\IdKeyEntity.cs">
       <Link>Entity\IdKeyEntity.cs</Link>
+    </Compile>
+	<Compile Include="..\OptimizelySDK\OptimizelyJson.cs">
+      <Link>OptimizelyJson.cs</Link>
     </Compile>
     <Compile Include="..\OptimizelySDK\Entity\TrafficAllocation.cs">
       <Link>Entity\TrafficAllocation.cs</Link>

OptimizelySDK.Net40/OptimizelySDK.Net40.csproj

@@ -98,6 +98,9 @@
     </Compile>
     <Compile Include="..\OptimizelySDK\Entity\IdKeyEntity.cs">
       <Link>Entity\IdKeyEntity.cs</Link>
+    </Compile>
+	<Compile Include="..\OptimizelySDK\OptimizelyJson.cs">
+      <Link>OptimizelyJson.cs</Link>
     </Compile>
     <Compile Include="..\OptimizelySDK\Entity\TrafficAllocation.cs">
       <Link>Entity\TrafficAllocation.cs</Link>

OptimizelySDK.NetStandard16/OptimizelySDK.NetStandard16.csproj

@@ -31,6 +31,7 @@
         <Compile Include="..\OptimizelySDK\Entity\ForcedVariation.cs" />
         <Compile Include="..\OptimizelySDK\Entity\Group.cs" />
         <Compile Include="..\OptimizelySDK\Entity\IdKeyEntity.cs" />
+        <Compile Include="..\OptimizelySDK\OptimizelyJson.cs" />
         <Compile Include="..\OptimizelySDK\Entity\TrafficAllocation.cs" />
         <Compile Include="..\OptimizelySDK\Entity\UserAttributes.cs" />
         <Compile Include="..\OptimizelySDK\Entity\Variation.cs" />

OptimizelySDK.NetStandard20/OptimizelySDK.NetStandard20.csproj

@@ -114,6 +114,9 @@
     </Compile>
     <Compile Include="..\OptimizelySDK\Entity\IdKeyEntity.cs">
       <Link>Entity\IdKeyEntity.cs</Link>
+    </Compile>
+	<Compile Include="..\OptimizelySDK\OptimizelyJson.cs">
+      <Link>Entity\OptimizelyJson.cs</Link>
     </Compile>
     <Compile Include="..\OptimizelySDK\Entity\Rollout.cs">
       <Link>Entity\Rollout.cs</Link>

OptimizelySDK.Tests/OptimizelyJsonTest.cs

@@ -0,0 +1,255 @@
+/**
+ *
+ *    Copyright 2020, 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 Moq;
+using NUnit.Framework;
+using OptimizelySDK.ErrorHandler;
+using OptimizelySDK.Exceptions;
+using OptimizelySDK.Logger;
+using System;
+using System.Collections.Generic;
+
+namespace OptimizelySDK.Tests
+{
+    class ParentJson
+    {
+        public string strField { get; set; }
+        public int intField { get; set; }
+        public double doubleField { get; set; }
+        public bool boolField { get; set; }
+        public ObjectJson objectField { get; set; }
+
+    }
+    class ObjectJson
+    {
+        public int inner_field_int { get; set; }
+        public double inner_field_double { get; set; }
+        public string inner_field_string {get;set;}
+        public bool inner_field_boolean { get; set; }
+    }
+
+    class Field4
+    {
+        public long inner_field1 { get; set; }
+        public InnerField2 inner_field2 { get; set; }
+    }
+    class InnerField2 : List<object> { }
+
+
+    [TestFixture]
+    public class OptimizelyJsonTest
+    {
+        private string Payload;
+        private Dictionary<string, object> Map;
+        private Mock<ILogger> LoggerMock;
+        private Mock<IErrorHandler> ErrorHandlerMock;
+
+        [SetUp]
+        public void Initialize()
+        {
+            ErrorHandlerMock = new Mock<IErrorHandler>();
+            ErrorHandlerMock.Setup(e => e.HandleError(It.IsAny<Exception>()));
+
+            LoggerMock = new Mock<ILogger>();
+            LoggerMock.Setup(i => i.Log(It.IsAny<LogLevel>(), It.IsAny<string>()));
+
+            Payload = "{ \"field1\": 1, \"field2\": 2.5, \"field3\": \"three\", \"field4\": {\"inner_field1\":3,\"inner_field2\":[\"1\",\"2\", 3, 4.23, true]}, \"field5\": true, }";
+            Map = new Dictionary<string, object>() {
+                { "strField", "john doe" },
+                { "intField", 12 },
+                { "doubleField", 2.23 },
+                { "boolField", true},
+                { "objectField", new Dictionary<string, object> () {
+                        { "inner_field_int", 3 },
+                        { "inner_field_double", 13.21 },
+                        { "inner_field_string", "john" },
+                        { "inner_field_boolean", true }
+                    }
+                }
+            };
+        }
+
+        [Test]
+        public void TestOptimizelyJsonObjectIsValid()
+        {
+            var optimizelyJSONUsingMap = new OptimizelyJson(Map, ErrorHandlerMock.Object, LoggerMock.Object);
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+
+            Assert.IsNotNull(optimizelyJSONUsingMap);
+            Assert.IsNotNull(optimizelyJSONUsingString);
+        }
+        [Test]
+        public void TestToStringReturnValidString()
+        {
+            var map = new Dictionary<string, object>() {
+                { "strField", "john doe" },
+                { "intField", 12 },
+                { "objectField", new Dictionary<string, object> () {
+                        { "inner_field_int", 3 }
+                    }
+                }
+            };
+            var optimizelyJSONUsingMap = new OptimizelyJson(map, ErrorHandlerMock.Object, LoggerMock.Object);
+            string str = optimizelyJSONUsingMap.ToString();
+            string expectedStringObj = "{\"strField\":\"john doe\",\"intField\":12,\"objectField\":{\"inner_field_int\":3}}";
+            Assert.AreEqual(expectedStringObj, str);
+        }
+
+        [Test]
+        public void TestGettingErrorUponInvalidJsonString()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson("{\"invalid\":}", ErrorHandlerMock.Object, LoggerMock.Object);
+            LoggerMock.Verify(log => log.Log(LogLevel.ERROR, "Provided string could not be converted to map."), Times.Once);
+            ErrorHandlerMock.Verify(er => er.HandleError(It.IsAny<InvalidJsonException>()), Times.Once);
+        }
+
+        [Test]
+        public void TestOptimizelyJsonGetVariablesWhenSetUsingMap()
+        {
+            var optimizelyJSONUsingMap = new OptimizelyJson(Map, ErrorHandlerMock.Object, LoggerMock.Object);
+
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<string>("strField"), "john doe");
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<int>("intField"), 12);
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<double>("doubleField"), 2.23);
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<bool>("boolField"), true);
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<int>("objectField.inner_field_int"), 3);
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<double>("objectField.inner_field_double"), 13.21);
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<string>("objectField.inner_field_string"), "john");
+            Assert.AreEqual(optimizelyJSONUsingMap.GetValue<bool>("objectField.inner_field_boolean"), true);
+            Assert.IsTrue(optimizelyJSONUsingMap.GetValue<Dictionary<string, object>>("objectField") is Dictionary<string, object>);
+        }
+
+        [Test]
+        public void TestOptimizelyJsonGetVariablesWhenSetUsingString()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+
+            Assert.AreEqual(optimizelyJSONUsingString.GetValue<long>("field1"), 1);
+            Assert.AreEqual(optimizelyJSONUsingString.GetValue<double>("field2"), 2.5);
+            Assert.AreEqual(optimizelyJSONUsingString.GetValue<string>("field3"), "three");
+            Assert.AreEqual(optimizelyJSONUsingString.GetValue<long>("field4.inner_field1"), 3);
+            Assert.True(TestData.CompareObjects(optimizelyJSONUsingString.GetValue<List<object>>("field4.inner_field2"), new List<object>() { "1", "2", 3, 4.23, true }));
+        }
+
+        [Test]
+        public void TestGetValueReturnsEntireDictWhenJsonPathIsEmptyAndTypeIsValid()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var actualDict = optimizelyJSONUsingString.ToDictionary();
+            var expectedValue = optimizelyJSONUsingString.GetValue<Dictionary<string, object>>("");
+            Assert.NotNull(expectedValue);
+            Assert.True(TestData.CompareObjects(expectedValue, actualDict));
+        }
+
+        [Test]
+        public void TestGetValueReturnsDefaultValueWhenJsonIsInvalid()
+        {
+            var payload = "{ \"field1\" : {1:\"Csharp\", 2:\"Java\"} }";
+            var optimizelyJSONUsingString = new OptimizelyJson(payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<Dictionary<float, string>>("field1");
+            // Even though above given JSON is not valid, newtonsoft is parsing it so
+            Assert.IsNotNull(expectedValue);
+        }
+
+        [Test]
+        public void TestGetValueReturnsDefaultValueWhenTypeIsInvalid()
+        {
+            var payload = "{ \"field1\" : {\"1\":\"Csharp\",\"2\":\"Java\"} }";
+            var optimizelyJSONUsingString = new OptimizelyJson(payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<Dictionary<float, string>>("field1");
+            Assert.IsNotNull(expectedValue);
+        }
+
+        [Test]
+        public void TestGetValueReturnsNullWhenJsonPathIsEmptyAndTypeIsOfObject()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<object>("");
+            Assert.NotNull(expectedValue);
+        }
+
+        [Test]
+        public void TestGetValueReturnsDefaultValueWhenJsonPathIsEmptyAndTypeIsNotValid()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<string>("");
+            Assert.IsNull(expectedValue);
+            LoggerMock.Verify(log => log.Log(LogLevel.ERROR, "Value for path could not be assigned to provided type."), Times.Once);
+            ErrorHandlerMock.Verify(er => er.HandleError(It.IsAny<OptimizelyRuntimeException>()), Times.Once);
+        }
+
+        [Test]
+        public void TestGetValueReturnsDefaultValueWhenJsonPathIsInvalid()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<string>("field11");
+            Assert.IsNull(expectedValue);
+            LoggerMock.Verify(log => log.Log(LogLevel.ERROR, "Value for JSON key not found."), Times.Once);
+            ErrorHandlerMock.Verify(er => er.HandleError(It.IsAny<OptimizelyRuntimeException>()), Times.Once);
+        }
+
+        [Test]
+        public void TestGetValueReturnsDefaultValueWhenJsonPath1IsInvalid()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<string>("field4.");
+            Assert.IsNull(expectedValue);
+            LoggerMock.Verify(log => log.Log(LogLevel.ERROR, "Value for JSON key not found."), Times.Once);
+            ErrorHandlerMock.Verify(er => er.HandleError(It.IsAny<OptimizelyRuntimeException>()), Times.Once);
+        }
+
+        [Test]
+        public void TestGetValueReturnsDefaultValueWhenJsonPath2IsInvalid()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<string>("field4..inner_field1");
+            Assert.IsNull(expectedValue);
+            LoggerMock.Verify(log => log.Log(LogLevel.ERROR, "Value for JSON key not found."), Times.Once);
+            ErrorHandlerMock.Verify(er => er.HandleError(It.IsAny<OptimizelyRuntimeException>()), Times.Once);
+        } 
+
+        [Test]
+        public void TestGetValueObjectNotModifiedIfCalledTwice()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<string>("field4.inner_field1");
+            var expectedValue2 = optimizelyJSONUsingString.GetValue<string>("field4.inner_field1");
+
+            Assert.AreEqual(expectedValue, expectedValue2);
+        }
+
+        [Test]
+        public void TestGetValueReturnsUsingGivenClassType()
+        {
+            var optimizelyJSONUsingString = new OptimizelyJson(Payload, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJSONUsingString.GetValue<Field4>("field4");
+
+            Assert.AreEqual(expectedValue.inner_field1, 3);
+            Assert.AreEqual(expectedValue.inner_field2, new List<object>() { "1", "2", 3, 4.23, true });
+        }
+
+        [Test]
+        public void TestGetValueReturnsCastedObject()
+        {
+            var optimizelyJson = new OptimizelyJson(Map, ErrorHandlerMock.Object, LoggerMock.Object);
+            var expectedValue = optimizelyJson.ToDictionary();
+            var actualValue = optimizelyJson.GetValue<ParentJson>(null);
+
+            Assert.IsTrue(TestData.CompareObjects(actualValue, expectedValue));
+        }
+    }
+}

OptimizelySDK.Tests/OptimizelySDK.Tests.csproj

@@ -77,6 +77,7 @@
     <Compile Include="ConfigTest\FallbackProjectConfigManagerTest.cs" />
     <Compile Include="DecisionServiceTest.cs" />
     <Compile Include="DefaultErrorHandlerTest.cs" />
+    <Compile Include="OptimizelyJsonTest.cs" />
     <Compile Include="EventTests\BatchEventProcessorTest.cs" />
     <Compile Include="EventTests\DefaultEventDispatcherTest.cs" />
     <Compile Include="EventTests\EventBuilderTest.cs" />

OptimizelySDK/Exceptions/OptimizelyException.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2017, Optimizely
+ * Copyright 2017, 2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,6 +33,14 @@ public OptimizelyRuntimeException(string message)
         {
         }
     }
+
+    public class InvalidJsonException : OptimizelyException
+    {
+        public InvalidJsonException(string message)
+            : base(message)
+        {
+        }
+    }
 
     public class InvalidAttributeException : OptimizelyException
     {