Skip to content

Commit c66a1ee

Browse files
mfahadahmedaliabbasrizvi
mfahadahmed
authored and
aliabbasrizvi
committed
feat(decision-listener): Incorporated new decision notification listener changes. (#157)
1 parent 02568aa commit c66a1ee

File tree

8 files changed

+289
-147
lines changed

8 files changed

+289
-147
lines changed

‎OptimizelySDK.Tests/DecisionServiceTest.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
*
3-
* Copyright 2017-2018, Optimizely and contributors
3+
* Copyright 2017-2019, Optimizely and contributors
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");
66
* you may not use this file except in compliance with the License.
@@ -511,7 +511,7 @@ public void TestGetVariationForFeatureExperimentGivenNonMutexGroupAndUserIsBucke
511511
{
512512
var experiment = ProjectConfig.GetExperimentFromKey("test_experiment_multivariate");
513513
var variation = ProjectConfig.GetVariationFromId("test_experiment_multivariate", "122231");
514-
var expectedDecision = new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_EXPERIMENT);
514+
var expectedDecision = new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_FEATURE_TEST);
515515
var userAttributes = new UserAttributes();
516516

517517
DecisionServiceMock.Setup(ds => ds.GetVariation(ProjectConfig.GetExperimentFromKey("test_experiment_multivariate"),
@@ -532,7 +532,7 @@ public void TestGetVariationForFeatureExperimentGivenMutexGroupAndUserIsBucketed
532532
var mutexExperiment = ProjectConfig.GetExperimentFromKey("group_experiment_1");
533533
var variation = mutexExperiment.Variations[0];
534534
var userAttributes = new UserAttributes();
535-
var expectedDecision = new FeatureDecision(mutexExperiment, variation, FeatureDecision.DECISION_SOURCE_EXPERIMENT);
535+
var expectedDecision = new FeatureDecision(mutexExperiment, variation, FeatureDecision.DECISION_SOURCE_FEATURE_TEST);
536536

537537
DecisionServiceMock.Setup(ds => ds.GetVariation(ProjectConfig.GetExperimentFromKey("group_experiment_1"), "user1",
538538
userAttributes)).Returns(variation);
@@ -781,7 +781,7 @@ public void TestGetVariationForFeatureWhenTheUserIsBucketedIntoFeatureExperiment
781781
var expectedExperimentId = featureFlag.ExperimentIds[0];
782782
var expectedExperiment = ProjectConfig.GetExperimentFromId(expectedExperimentId);
783783
var variation = expectedExperiment.Variations[0];
784-
var expectedDecision = new FeatureDecision(expectedExperiment, variation, FeatureDecision.DECISION_SOURCE_EXPERIMENT);
784+
var expectedDecision = new FeatureDecision(expectedExperiment, variation, FeatureDecision.DECISION_SOURCE_FEATURE_TEST);
785785

786786
DecisionServiceMock.Setup(ds => ds.GetVariationForFeatureExperiment(It.IsAny<FeatureFlag>(), It.IsAny<string>(),
787787
It.IsAny<UserAttributes>())).Returns(expectedDecision);
@@ -838,7 +838,7 @@ public void TestGetVariationForFeatureWhenTheUserIsBuckedtedInBothExperimentAndR
838838
var featureFlag = ProjectConfig.GetFeatureFlagFromKey("string_single_variable_feature");
839839
var experiment = ProjectConfig.GetExperimentFromKey("test_experiment_with_feature_rollout");
840840
var variation = ProjectConfig.GetVariationFromId("test_experiment_with_feature_rollout", "122236");
841-
var expectedDecision = new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_EXPERIMENT);
841+
var expectedDecision = new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_FEATURE_TEST);
842842
var userAttributes = new UserAttributes {
843843
{ "browser_type", "chrome" }
844844
};

‎OptimizelySDK.Tests/OptimizelyTest.cs‎

Lines changed: 216 additions & 118 deletions
Large diffs are not rendered by default.

‎OptimizelySDK.Tests/ProjectConfigTest.cs‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -874,5 +874,23 @@ public void TestExperimentAudiencesRetrivedFromTypedAudiencesFirstThenFromAudien
874874
var expectedAudienceIds = new string[] { "3468206642", "3988293898", "3988293899", "3468206646", "3468206647", "3468206644", "3468206643" };
875875
Assert.That(expectedAudienceIds, Is.EquivalentTo(experiment.AudienceIds));
876876
}
877+
878+
[Test]
879+
public void TestIsFeatureExperimentReturnsFalseForExperimentThatDoesNotBelongToAnyFeature()
880+
{
881+
var typedConfig = ProjectConfig.Create(TestData.TypedAudienceDatafile, null, null);
882+
var experiment = typedConfig.GetExperimentFromKey("typed_audience_experiment");
883+
884+
Assert.False(typedConfig.IsFeatureExperiment(experiment.Id));
885+
}
886+
887+
[Test]
888+
public void TestIsFeatureExperimentReturnsTrueForExperimentThatBelongsToAFeature()
889+
{
890+
var typedConfig = ProjectConfig.Create(TestData.TypedAudienceDatafile, null, null);
891+
var experiment = typedConfig.GetExperimentFromKey("feat2_with_var_test");
892+
893+
Assert.True(typedConfig.IsFeatureExperiment(experiment.Id));
894+
}
877895
}
878896
}

‎OptimizelySDK/Bucketing/DecisionService.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ public virtual FeatureDecision GetVariationForFeatureExperiment(FeatureFlag feat
353353
if (variation != null && !string.IsNullOrEmpty(variation.Id))
354354
{
355355
Logger.Log(LogLevel.INFO, $"The user \"{userId}\" is bucketed into experiment \"{experiment.Key}\" of feature \"{featureFlag.Key}\".");
356-
return new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_EXPERIMENT);
356+
return new FeatureDecision(experiment, variation, FeatureDecision.DECISION_SOURCE_FEATURE_TEST);
357357
}
358358
}
359359

‎OptimizelySDK/Entity/FeatureDecision.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ namespace OptimizelySDK.Entity
1818
{
1919
public class FeatureDecision
2020
{
21-
public const string DECISION_SOURCE_EXPERIMENT = "EXPERIMENT";
22-
public const string DECISION_SOURCE_ROLLOUT = "ROLLOUT";
21+
public const string DECISION_SOURCE_FEATURE_TEST = "feature-test";
22+
public const string DECISION_SOURCE_ROLLOUT = "rollout";
2323

2424
public Experiment Experiment { get; }
2525
public Variation Variation { get; }

‎OptimizelySDK/Optimizely.cs‎

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,8 @@ public Variation GetVariation(string experimentKey, string userId, UserAttribute
308308
};
309309

310310
userAttributes = userAttributes ?? new UserAttributes();
311-
NotificationCenter.SendNotifications(NotificationCenter.NotificationType.Decision, DecisionInfoTypes.EXPERIMENT, userId,
311+
var decisionNotificationType = Config.IsFeatureExperiment(experiment.Id) ? DecisionNotificationTypes.FEATURE_TEST : DecisionNotificationTypes.AB_TEST;
312+
NotificationCenter.SendNotifications(NotificationCenter.NotificationType.Decision, decisionNotificationType, userId,
312313
userAttributes, decisionInfo);
313314
return variation;
314315
}
@@ -380,20 +381,19 @@ public virtual bool IsFeatureEnabled(string featureKey, string userId, UserAttri
380381
if (!Validator.IsFeatureFlagValid(Config, featureFlag))
381382
return false;
382383

383-
string experimentKey = null;
384-
string variationKey = null;
385384
bool featureEnabled = false;
385+
var sourceInfo = new Dictionary<string, string>();
386386
var decision = DecisionService.GetVariationForFeature(featureFlag, userId, userAttributes);
387387

388388
if (decision.Variation != null)
389389
{
390390
var variation = decision.Variation;
391391
featureEnabled = variation.FeatureEnabled.GetValueOrDefault();
392392

393-
if (decision.Source == FeatureDecision.DECISION_SOURCE_EXPERIMENT)
393+
if (decision.Source == FeatureDecision.DECISION_SOURCE_FEATURE_TEST)
394394
{
395-
experimentKey = decision.Experiment.Key;
396-
variationKey = variation.Key;
395+
sourceInfo["experimentKey"] = decision.Experiment.Key;
396+
sourceInfo["variationKey"] = variation.Key;
397397
SendImpressionEvent(decision.Experiment, variation, userId, userAttributes);
398398
}
399399
else
@@ -412,11 +412,10 @@ public virtual bool IsFeatureEnabled(string featureKey, string userId, UserAttri
412412
{ "featureKey", featureKey },
413413
{ "featureEnabled", featureEnabled },
414414
{ "source", decision.Source },
415-
{ "sourceExperimentKey", experimentKey },
416-
{ "sourceVariationKey", variationKey },
415+
{ "sourceInfo", sourceInfo },
417416
};
418417

419-
NotificationCenter.SendNotifications(NotificationCenter.NotificationType.Decision, DecisionInfoTypes.FEATURE, userId,
418+
NotificationCenter.SendNotifications(NotificationCenter.NotificationType.Decision, DecisionNotificationTypes.FEATURE, userId,
420419
userAttributes ?? new UserAttributes(), decisionInfo);
421420
return featureEnabled;
422421
}
@@ -494,12 +493,11 @@ public virtual T GetFeatureVariableValueForType<T>(string featureKey, string var
494493
$@"User ""{userId}"" is not in any variation for feature flag ""{featureKey}"", returning default value ""{variableValue}"".");
495494
}
496495

497-
string experimentKey = null;
498-
string variationKey = null;
499-
if (decision?.Source == FeatureDecision.DECISION_SOURCE_EXPERIMENT)
496+
var sourceInfo = new Dictionary<string, string>();
497+
if (decision?.Source == FeatureDecision.DECISION_SOURCE_FEATURE_TEST)
500498
{
501-
experimentKey = decision.Experiment.Key;
502-
variationKey = decision.Variation.Key;
499+
sourceInfo["experimentKey"] = decision.Experiment.Key;
500+
sourceInfo["variationKey"] = decision.Variation.Key;
503501
}
504502

505503
var typeCastedValue = GetTypeCastedVariableValue(variableValue, variableType);
@@ -511,11 +509,10 @@ public virtual T GetFeatureVariableValueForType<T>(string featureKey, string var
511509
{ "variableValue", typeCastedValue },
512510
{ "variableType", variableType.ToString().ToLower() },
513511
{ "source", decision?.Source },
514-
{ "sourceExperimentKey", experimentKey },
515-
{ "sourceVariationKey", variationKey },
512+
{ "sourceInfo", sourceInfo },
516513
};
517514

518-
NotificationCenter.SendNotifications(NotificationCenter.NotificationType.Decision, DecisionInfoTypes.FEATURE_VARIABLE, userId,
515+
NotificationCenter.SendNotifications(NotificationCenter.NotificationType.Decision, DecisionNotificationTypes.FEATURE_VARIABLE, userId,
519516
userAttributes ?? new UserAttributes(), decisionInfo);
520517
return (T)typeCastedValue;
521518
}

‎OptimizelySDK/ProjectConfig.cs‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,13 @@ private Dictionary<string, Dictionary<string, Variation>> _VariationIdMap
148148
/// </summary>
149149
private Dictionary<string, Rollout> _RolloutIdMap;
150150
public Dictionary<string, Rollout> RolloutIdMap { get { return _RolloutIdMap; } }
151-
151+
152+
/// <summary>
153+
/// Associative array of experiment IDs that exist in any feature
154+
/// for checking that experiment is a feature experiment.
155+
/// </summary>
156+
private Dictionary<string, List<string>> ExperimentFeatureMap = new Dictionary<string, List<string>>();
157+
152158

153159
//========================= Callbacks ===========================
154160

@@ -293,6 +299,18 @@ private void Initialize()
293299
}
294300
}
295301
}
302+
303+
// Adding experiments in experiment-feature map.
304+
foreach (var feature in FeatureFlags)
305+
{
306+
foreach (var experimentId in feature.ExperimentIds ?? new List<string>())
307+
{
308+
if (ExperimentFeatureMap.ContainsKey(experimentId))
309+
ExperimentFeatureMap[experimentId].Add(feature.Id);
310+
else
311+
ExperimentFeatureMap[experimentId] = new List<string> { feature.Id };
312+
}
313+
}
296314
}
297315

298316
public static ProjectConfig Create(string content, ILogger logger, IErrorHandler errorHandler)
@@ -617,5 +635,15 @@ public string GetAttributeId(string attributeKey)
617635
Logger.Log(LogLevel.ERROR, $@"Attribute key ""{attributeKey}"" is not in datafile.");
618636
return null;
619637
}
638+
639+
/// <summary>
640+
/// Check if the provided experiment Id belongs to any feature, false otherwise.
641+
/// </summary>
642+
/// <param name="experimentId">Experiment Id</param>
643+
/// <returns>true if experiment belongs to any feature, false otherwise</returns>
644+
public bool IsFeatureExperiment(string experimentId)
645+
{
646+
return ExperimentFeatureMap.ContainsKey(experimentId);
647+
}
620648
}
621649
}

‎OptimizelySDK/Utils/DecisionInfoTypes.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@
1616

1717
namespace OptimizelySDK.Utils
1818
{
19-
public static class DecisionInfoTypes
19+
public static class DecisionNotificationTypes
2020
{
21+
public const string AB_TEST = "ab-test";
2122
public const string FEATURE = "feature";
22-
public const string EXPERIMENT = "experiment";
23-
public const string FEATURE_VARIABLE = "feature_variable";
23+
public const string FEATURE_TEST = "feature-test";
24+
public const string FEATURE_VARIABLE = "feature-variable";
2425
}
2526
}

0 commit comments

Comments
 (0)