Skip to content

[FME-4193] Update Impression Manager and strategies #273

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

Open
wants to merge 2 commits into
base: feature/FME-4192-properties-validator
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion Splitio.Redis/Services/Client/Classes/RedisClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ private void BuildImpressionManager()
{
var shouldCalculatePreviousTime = _config.ImpressionsMode == ImpressionsMode.Optimized;

_impressionsManager = new ImpressionsManager(_impressionsLog, _customerImpressionListener, _impressionsCounter, shouldCalculatePreviousTime, _config.ImpressionsMode, null, _tasksManager, _uniqueKeysTracker, _impressionsObserver, _config.LabelsEnabled);
_impressionsManager = new ImpressionsManager(_impressionsLog, _customerImpressionListener, _impressionsCounter, shouldCalculatePreviousTime, _config.ImpressionsMode, null, _tasksManager, _uniqueKeysTracker, _impressionsObserver, _config.LabelsEnabled, _propertiesValidator);
}

private void BuildEventLog()
Expand Down
2 changes: 1 addition & 1 deletion src/Splitio/Services/Client/Classes/JSONFileClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public JSONFileClient(string splitsFilePath,
_uniqueKeysTracker = new NoopUniqueKeysTracker();
_impressionsCounter = new NoopImpressionsCounter();
_impressionsObserver = new NoopImpressionsObserver();
_impressionsManager = impressionsManager ?? new ImpressionsManager(impressionsLog, null, _impressionsCounter, false, ImpressionsMode.Debug, null, _tasksManager, _uniqueKeysTracker, _impressionsObserver, isLabelsEnabled);
_impressionsManager = impressionsManager ?? new ImpressionsManager(impressionsLog, null, _impressionsCounter, false, ImpressionsMode.Debug, null, _tasksManager, _uniqueKeysTracker, _impressionsObserver, isLabelsEnabled, _propertiesValidator);

BuildClientExtension();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Splitio/Services/Client/Classes/LocalhostClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public LocalhostClient(ConfigurationOptions configurationOptions) : base("localh
_uniqueKeysTracker = new NoopUniqueKeysTracker();
_impressionsCounter = new NoopImpressionsCounter();
_impressionsObserver = new NoopImpressionsObserver();
_impressionsManager = new ImpressionsManager(null, null, _impressionsCounter, false, ImpressionsMode.Debug, null, _tasksManager, _uniqueKeysTracker, _impressionsObserver, false);
_impressionsManager = new ImpressionsManager(null, null, _impressionsCounter, false, ImpressionsMode.Debug, null, _tasksManager, _uniqueKeysTracker, _impressionsObserver, false, _propertiesValidator);

BuildClientExtension();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ private void BuildImpressionsObserver()

private void BuildImpressionManager()
{
_impressionsManager = new ImpressionsManager(_impressionsLog, _customerImpressionListener, _impressionsCounter, true, _config.ImpressionsMode, _telemetryRuntimeProducer, _tasksManager, _uniqueKeysTracker, _impressionsObserver, _config.LabelsEnabled);
_impressionsManager = new ImpressionsManager(_impressionsLog, _customerImpressionListener, _impressionsCounter, true, _config.ImpressionsMode, _telemetryRuntimeProducer, _tasksManager, _uniqueKeysTracker, _impressionsObserver, _config.LabelsEnabled, _propertiesValidator);
}

private void BuildEventLog()
Expand Down
10 changes: 5 additions & 5 deletions src/Splitio/Services/Client/Classes/SplitClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public abstract class SplitClient : ISplitClient
protected readonly IKeyValidator _keyValidator;
protected readonly ISplitNameValidator _splitNameValidator;
protected readonly IEventTypeValidator _eventTypeValidator;
protected readonly IPropertiesValidator _eventPropertiesValidator;
protected readonly IPropertiesValidator _propertiesValidator;
protected readonly IWrapperAdapter _wrapperAdapter;
protected readonly IConfigService _configService;
protected readonly IFlagSetsValidator _flagSetsValidator;
Expand Down Expand Up @@ -71,7 +71,7 @@ public SplitClient(string apikey)
_keyValidator = new KeyValidator();
_splitNameValidator = new SplitNameValidator();
_eventTypeValidator = new EventTypeValidator();
_eventPropertiesValidator = new PropertiesValidator();
_propertiesValidator = new PropertiesValidator();
_factoryInstantiationsService = FactoryInstantiationsService.Instance();
_flagSetsValidator = new FlagSetsValidator();
_configService = new ConfigService(_wrapperAdapter, _flagSetsValidator, new SdkMetadataValidator());
Expand Down Expand Up @@ -412,7 +412,7 @@ protected void BuildImpressionsCounter(BaseConfig config)

protected void BuildClientExtension()
{
_clientExtensionService = new ClientExtensionService(_blockUntilReadyService, _statusManager, _keyValidator, _splitNameValidator, _telemetryEvaluationProducer, _eventTypeValidator, _eventPropertiesValidator, _trafficTypeValidator, _flagSetsValidator, _flagSetsFilter);
_clientExtensionService = new ClientExtensionService(_blockUntilReadyService, _statusManager, _keyValidator, _splitNameValidator, _telemetryEvaluationProducer, _eventTypeValidator, _propertiesValidator, _trafficTypeValidator, _flagSetsValidator, _flagSetsFilter);
}

protected void BuildFlagSetsFilter(HashSet<string> sets)
Expand Down Expand Up @@ -520,13 +520,13 @@ private List<TreatmentResult> GetTreatmentsByFlagSets(Enums.API method, Key key,
}
}

private List<KeyImpression> BuildAndGetImpressions(List<TreatmentResult> treatments, Key key)
private List<KeyImpression> BuildAndGetImpressions(List<TreatmentResult> treatments, Key key, Dictionary<string, object> properties = null)
{
var impressions = new List<KeyImpression>();

foreach (var treatment in treatments)
{
var impression = _impressionsManager.Build(treatment, key);
var impression = _impressionsManager.Build(treatment, key, properties);

if (impression != null) impressions.Add(impression);
}
Expand Down
61 changes: 41 additions & 20 deletions src/Splitio/Services/Impressions/Classes/ImpressionsManager.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
using Splitio.Domain;
using Newtonsoft.Json;
using Splitio.Domain;
using Splitio.Services.Impressions.Interfaces;
using Splitio.Services.InputValidation.Interfaces;
using Splitio.Services.Logger;
using Splitio.Services.Shared.Classes;
using Splitio.Services.Tasks;
Expand All @@ -24,6 +26,7 @@ public class ImpressionsManager : IImpressionsManager
private readonly ITasksManager _taskManager;
private readonly ImpressionsMode _impressionsMode;
private readonly IUniqueKeysTracker _uniqueKeysTracker;
private readonly IPropertiesValidator _propertiesValidator;
private readonly bool _addPreviousTime;
private readonly bool _labelsEnabled;

Expand All @@ -36,7 +39,8 @@ public ImpressionsManager(IImpressionsLog impressionsLog,
ITasksManager taskManager,
IUniqueKeysTracker uniqueKeysTracker,
IImpressionsObserver impressionsObserver,
bool labelsEnabled)
bool labelsEnabled,
IPropertiesValidator propertiesValidator)
{
_impressionsLog = impressionsLog;
_customerImpressionListener = customerImpressionListener;
Expand All @@ -48,14 +52,21 @@ public ImpressionsManager(IImpressionsLog impressionsLog,
_impressionsMode = impressionsMode;
_uniqueKeysTracker = uniqueKeysTracker;
_labelsEnabled = labelsEnabled;
_propertiesValidator = propertiesValidator;
}

#region Public Methods
public KeyImpression Build(TreatmentResult result, Key key)
public KeyImpression Build(TreatmentResult result, Key key, Dictionary<string, object> properties)
{
if (Labels.SplitNotFound.Equals(result.Label)) return null;

var impression = new KeyImpression(key.matchingKey, result.FeatureFlagName, result.Treatment, result.ImpTime, result.ChangeNumber, _labelsEnabled ? result.Label : null, key.bucketingKeyHadValue ? key.bucketingKey : null, result.ImpressionsDisabled);

var validatorResult = _propertiesValidator.IsValid(properties);
if (validatorResult.Success)
{
impression.Properties = JsonConvert.SerializeObject(validatorResult.Value);
}

try
{
Expand All @@ -64,19 +75,23 @@ public KeyImpression Build(TreatmentResult result, Key key)
{
_impressionsCounter.Inc(result.FeatureFlagName, result.ImpTime);
_uniqueKeysTracker.Track(key.matchingKey, result.FeatureFlagName);
} else if (_impressionsMode == ImpressionsMode.Debug)
{
// In DEBUG mode we should calculate the pt only.

ShouldCalculatePreviousTime(impression);
} else if (_impressionsMode == ImpressionsMode.Optimized)
}
else if (string.IsNullOrEmpty(impression.Properties))
{
// In OPTIMIZED mode we should track the total amount of evaluations and deduplicate the impressions.

ShouldCalculatePreviousTime(impression);
if (impression.PreviousTime.HasValue)
_impressionsCounter.Inc(result.FeatureFlagName, result.ImpTime);
impression.Optimized = ShouldQueueImpression(impression);
switch (_impressionsMode)
{
case ImpressionsMode.Debug:
// In DEBUG mode we should calculate the pt only.
ShouldCalculatePreviousTime(impression);
break;
case ImpressionsMode.Optimized:
// In OPTIMIZED mode we should track the total amount of evaluations and deduplicate the impressions.
ShouldCalculatePreviousTime(impression);
if (impression.PreviousTime.HasValue)
_impressionsCounter.Inc(result.FeatureFlagName, result.ImpTime);
impression.Optimized = ShouldQueueImpression(impression);
break;
}
}
}
catch (Exception ex)
Expand Down Expand Up @@ -165,20 +180,26 @@ private bool GetImpressionsToTrack(List<KeyImpression> impressions, out List<Key
.Where(i => !i.ImpressionsDisabled)
.ToList();

if (filteredImpressions.Count == 0) return false;
if (filteredImpressions.Count == 0)
{
return false;
}

switch (_impressionsMode)
{
case ImpressionsMode.Debug:
impressionsToTrack.AddRange(filteredImpressions);
impressionsToTrack = filteredImpressions;
break;
case ImpressionsMode.Optimized:
default:
impressionsToTrack.AddRange(filteredImpressions.Where(i => i.Optimized).ToList());
var deduped = filteredImpressions.Count - impressionsToTrack.Count;
_telemetryRuntimeProducer?.RecordImpressionsStats(ImpressionsEnum.ImpressionsDeduped, deduped);
impressionsToTrack = filteredImpressions
.Where(i => i.Optimized || !string.IsNullOrEmpty(i.Properties))
.ToList();

_telemetryRuntimeProducer?.RecordImpressionsStats(ImpressionsEnum.ImpressionsDeduped, filteredImpressions.Count - impressionsToTrack.Count);
break;
}

return true;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Splitio.Services.Impressions.Interfaces
{
public interface IImpressionsManager
{
KeyImpression Build(TreatmentResult treatmentResult, Key key);
KeyImpression Build(TreatmentResult treatmentResult, Key key, Dictionary<string, object> properties);
void Track(List<KeyImpression> impressions);
Task TrackAsync(List<KeyImpression> impressions);
}
Expand Down
Loading