Skip to content
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.

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

feat(decide): add UserContext #248

Merged
merged 15 commits into from
Dec 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
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
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
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
110 changes: 110 additions & 0 deletions OptimizelySDK.Tests/OptimizelyDecisions/OptimizelyDecisionTest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
/*
* Copyright 2020, Optimizely
*
* 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.Logger;
using OptimizelySDK.OptimizelyDecisions;
using System;
using System.Collections.Generic;

namespace OptimizelySDK.Tests.OptimizelyDecisions
{
[TestFixture]
public class OptimizelyDecisionTest
{
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>()));
}

[Test]
public void TestNewErrorDecision()
{
var optimizelyDecision = OptimizelyDecision.NewErrorDecision("var_key", null, "some error message", ErrorHandlerMock.Object, LoggerMock.Object);
Assert.IsNull(optimizelyDecision.VariationKey);
Assert.AreEqual(optimizelyDecision.FlagKey, "var_key");
Assert.AreEqual(optimizelyDecision.Variables.ToDictionary(), new Dictionary<string, object>());
Assert.AreEqual(optimizelyDecision.Reasons, new List<string>() { "some error message" });
Assert.IsNull(optimizelyDecision.RuleKey);
Assert.False(optimizelyDecision.Enabled);
}

[Test]
public void TestNewDecision()
{
var variableMap = new Dictionary<string, object>() {
{ "strField", "john doe" },
{ "intField", 12 },
{ "objectField", new Dictionary<string, object> () {
{ "inner_field_int", 3 }
}
}
};
var optimizelyJSONUsingMap = new OptimizelyJSON(variableMap, ErrorHandlerMock.Object, LoggerMock.Object);
string expectedStringObj = "{\"strField\":\"john doe\",\"intField\":12,\"objectField\":{\"inner_field_int\":3}}";

var optimizelyDecision = new OptimizelyDecision("var_key",
true,
optimizelyJSONUsingMap,
"experiment",
"feature_key",
null,
new string[0]);
Assert.AreEqual(optimizelyDecision.VariationKey, "var_key");
Assert.AreEqual(optimizelyDecision.FlagKey, "feature_key");
Assert.AreEqual(optimizelyDecision.Variables.ToString(), expectedStringObj);
Assert.AreEqual(optimizelyDecision.Reasons, new List<string>());
Assert.AreEqual(optimizelyDecision.RuleKey, "experiment");
Assert.True(optimizelyDecision.Enabled);
}

[Test]
public void TestNewDecisionReasonWithIncludeReasons()
{
var decisionReasons = DefaultDecisionReasons.NewInstance(new List<OptimizelyDecideOption>() { OptimizelyDecideOption.INCLUDE_REASONS });
decisionReasons.AddError(DecisionMessage.Reason(DecisionMessage.FLAG_KEY_INVALID, "invalid_key"));

Assert.AreEqual(decisionReasons.ToReport()[0], "No flag was found for key \"invalid_key\".");
decisionReasons.AddError(DecisionMessage.Reason(DecisionMessage.VARIABLE_VALUE_INVALID, "invalid_key"));
Assert.AreEqual(decisionReasons.ToReport()[1], "Variable value for key \"invalid_key\" is invalid or wrong type.");
decisionReasons.AddInfo("Some info message.");
Assert.AreEqual(decisionReasons.ToReport()[2], "Some info message.");
}

[Test]
public void TestNewDecisionReasonWithoutIncludeReasons()
{
var decisionReasons = DefaultDecisionReasons.NewInstance();
decisionReasons.AddError(DecisionMessage.Reason(DecisionMessage.FLAG_KEY_INVALID, "invalid_key"));

Assert.AreEqual(decisionReasons.ToReport()[0], "No flag was found for key \"invalid_key\".");
decisionReasons.AddError(DecisionMessage.Reason(DecisionMessage.VARIABLE_VALUE_INVALID, "invalid_key"));
Assert.AreEqual(decisionReasons.ToReport()[1], "Variable value for key \"invalid_key\" is invalid or wrong type.");
decisionReasons.AddInfo("Some info message.");
Assert.AreEqual(decisionReasons.ToReport().Count, 2);
}
}
}
2 changes: 2 additions & 0 deletions OptimizelySDK.Tests/OptimizelySDK.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
<Compile Include="DecisionServiceTest.cs" />
<Compile Include="DefaultErrorHandlerTest.cs" />
<Compile Include="EventTests\EventProcessorProps.cs" />
<Compile Include="OptimizelyDecisions\OptimizelyDecisionTest.cs" />
<Compile Include="OptimizelyJSONTest.cs" />
<Compile Include="EventTests\BatchEventProcessorTest.cs" />
<Compile Include="EventTests\DefaultEventDispatcherTest.cs" />
Expand All @@ -90,6 +91,7 @@
<Compile Include="NotificationTests\NotificationCenterTests.cs" />
<Compile Include="ClientConfigHandlerTest.cs" />
<Compile Include="OptimizelyTest.cs" />
<Compile Include="OptimizelyUserContextTest.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="TestBucketer.cs" />
<Compile Include="BucketerTest.cs" />
Expand Down
80 changes: 80 additions & 0 deletions OptimizelySDK.Tests/OptimizelyTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,86 @@ public PrivateObject CreatePrivateOptimizely()
}
#endregion

#region Test UserContext

[Test]
public void TestCreateUserContext()
{
var attribute = new UserAttributes
{
{ "device_type", "iPhone" },
{ "location", "San Francisco" }
};
var optlyUserContext = Optimizely.CreateUserContext(TestUserId, attribute);
Assert.AreEqual(TestUserId, optlyUserContext.UserId);
Assert.AreEqual(Optimizely, optlyUserContext.Optimizely);
Assert.AreEqual(attribute, optlyUserContext.UserAttributes);
}

[Test]
public void TestCreateUserContextWithoutAttributes()
{
var optlyUserContext = Optimizely.CreateUserContext(TestUserId);
Assert.AreEqual(TestUserId, optlyUserContext.UserId);
Assert.AreEqual(Optimizely, optlyUserContext.Optimizely);
Assert.IsTrue(optlyUserContext.UserAttributes.Count == 0);
}

[Test]
public void TestCreateUserContextMultipleAttribute()
{

var attribute1 = new UserAttributes
{
{ "device_type", "iPhone" },
{ "location", "San Francisco" }
};
var optlyUserContext1 = Optimizely.CreateUserContext("userId1", attribute1);

var attribute2 = new UserAttributes
{
{ "device_type2", "Samsung" },
{ "location2", "California" }
};
var optlyUserContext2 = Optimizely.CreateUserContext("userId2", attribute2);

Assert.AreEqual("userId1", optlyUserContext1.UserId);
Assert.AreEqual(Optimizely, optlyUserContext1.Optimizely);
Assert.AreEqual(attribute1, optlyUserContext1.UserAttributes);

Assert.AreEqual("userId2", optlyUserContext2.UserId);
Assert.AreEqual(Optimizely, optlyUserContext2.Optimizely);
Assert.AreEqual(attribute2, optlyUserContext2.UserAttributes);
}

[Test]
public void TestChangeAttributeDoesNotEffectValues()
{
var userId = "testUserId";
var attribute = new UserAttributes
{
{ "device_type", "iPhone" },
{ "location", "San Francisco" }
};
var optlyUserContext = Optimizely.CreateUserContext(userId, attribute);
Assert.AreEqual(TestUserId, optlyUserContext.UserId);
Assert.AreEqual(Optimizely, optlyUserContext.Optimizely);
Assert.AreEqual(attribute, optlyUserContext.UserAttributes);

attribute = new UserAttributes
{
{ "device_type", "iPhone" },
{ "level", "low" },
{ "location", "San Francisco" }
};
userId = "InvalidUser";
Assert.AreEqual("testUserId", optlyUserContext.UserId);
Assert.AreEqual(Optimizely, optlyUserContext.Optimizely);
Assert.AreNotEqual(attribute, optlyUserContext.UserAttributes);
}

#endregion

#region Test Validate
[Test]
public void TestInvalidInstanceLogMessages()
Expand Down
Loading