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

Avoid redundant validation for cached TargetingFilterSettings #387

Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,14 @@ public ContextualTargetingFilter(IOptions<TargetingEvaluationOptions> options =
/// <returns><see cref="TargetingFilterSettings"/> that can later be used in targeting.</returns>
public object BindParameters(IConfiguration filterParameters)
{
return filterParameters.Get<TargetingFilterSettings>() ?? new TargetingFilterSettings();
TargetingFilterSettings settings = filterParameters.Get<TargetingFilterSettings>() ?? new TargetingFilterSettings();

if (!TargetingEvaluator.TryValidateSettings(settings, out string paramName, out string reason))
{
throw new ArgumentException(reason, paramName);
}

return settings;
}

/// <summary>
Expand Down
133 changes: 64 additions & 69 deletions src/Microsoft.FeatureManagement/Targeting/TargetingEvaluator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,70 @@ private static StringComparison GetComparisonType(bool ignoreCase) =>
const string OutOfRange = "The value is out of the accepted range.";
const string RequiredParameter = "Value cannot be null.";

/// <summary>
/// Performs validation of targeting settings.
/// </summary>
/// <param name="targetingSettings">The settings to validate.</param>
/// <param name="paramName">The name of the invalid setting, if any.</param>
/// <param name="reason">The reason that the setting is invalid.</param>
/// <returns>True if the provided settings are valid. False if the provided settings are invalid.</returns>
public static bool TryValidateSettings(TargetingFilterSettings targetingSettings, out string paramName, out string reason)
{
paramName = null;

reason = null;

if (targetingSettings == null)
{
paramName = nameof(targetingSettings);

reason = RequiredParameter;

return false;
}

if (targetingSettings.Audience == null)
{
paramName = nameof(targetingSettings.Audience);

reason = RequiredParameter;

return false;
}

if (targetingSettings.Audience.DefaultRolloutPercentage < 0 || targetingSettings.Audience.DefaultRolloutPercentage > 100)
{
paramName = $"{targetingSettings.Audience}.{targetingSettings.Audience.DefaultRolloutPercentage}";

reason = OutOfRange;

return false;
}

if (targetingSettings.Audience.Groups != null)
{
int index = 0;

foreach (GroupRollout groupRollout in targetingSettings.Audience.Groups)
{
index++;

if (groupRollout.RolloutPercentage < 0 || groupRollout.RolloutPercentage > 100)
{
//
// Audience.Groups[1].RolloutPercentage
paramName = $"{targetingSettings.Audience}.{targetingSettings.Audience.Groups}[{index}].{groupRollout.RolloutPercentage}";

reason = OutOfRange;

return false;
}
}
}

return true;
}

/// <summary>
/// Checks if a provided targeting context should be targeted given targeting settings.
/// </summary>
Expand All @@ -35,11 +99,6 @@ public static bool IsTargeted(ITargetingContext targetingContext, TargetingFilte
throw new ArgumentNullException(nameof(targetingContext));
}

if (!TryValidateSettings(settings, out string paramName, out string reason))
{
throw new ArgumentException(reason, paramName);
}

if (settings.Audience.Exclusion != null)
{
//
Expand Down Expand Up @@ -229,70 +288,6 @@ public static bool IsTargeted(
return IsTargeted(defaultContextId, 0, defaultRolloutPercentage);
}

/// <summary>
/// Performs validation of targeting settings.
/// </summary>
/// <param name="targetingSettings">The settings to validate.</param>
/// <param name="paramName">The name of the invalid setting, if any.</param>
/// <param name="reason">The reason that the setting is invalid.</param>
/// <returns>True if the provided settings are valid. False if the provided settings are invalid.</returns>
private static bool TryValidateSettings(TargetingFilterSettings targetingSettings, out string paramName, out string reason)
{
paramName = null;

reason = null;

if (targetingSettings == null)
{
paramName = nameof(targetingSettings);

reason = RequiredParameter;

return false;
}

if (targetingSettings.Audience == null)
{
paramName = nameof(targetingSettings.Audience);

reason = RequiredParameter;

return false;
}

if (targetingSettings.Audience.DefaultRolloutPercentage < 0 || targetingSettings.Audience.DefaultRolloutPercentage > 100)
{
paramName = $"{targetingSettings.Audience}.{targetingSettings.Audience.DefaultRolloutPercentage}";

reason = OutOfRange;

return false;
}

if (targetingSettings.Audience.Groups != null)
{
int index = 0;

foreach (GroupRollout groupRollout in targetingSettings.Audience.Groups)
{
index++;

if (groupRollout.RolloutPercentage < 0 || groupRollout.RolloutPercentage > 100)
{
//
// Audience.Groups[1].RolloutPercentage
paramName = $"{targetingSettings.Audience}.{targetingSettings.Audience.Groups}[{index}].{groupRollout.RolloutPercentage}";

reason = OutOfRange;

return false;
}
}
}

return true;
}

/// <summary>
/// Determines if a given context id should be targeted based off the provided percentage range
/// </summary>
Expand Down
10 changes: 9 additions & 1 deletion src/Microsoft.FeatureManagement/Targeting/TargetingFilter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.FeatureManagement.Targeting;
using System;
using System.Threading.Tasks;

Expand Down Expand Up @@ -40,7 +41,14 @@ public TargetingFilter(ITargetingContextAccessor contextAccessor, IOptions<Targe
/// <returns><see cref="TargetingFilterSettings"/> that can later be used in targeting.</returns>
public object BindParameters(IConfiguration filterParameters)
{
return filterParameters.Get<TargetingFilterSettings>() ?? new TargetingFilterSettings();
TargetingFilterSettings settings = filterParameters.Get<TargetingFilterSettings>() ?? new TargetingFilterSettings();

if (!TargetingEvaluator.TryValidateSettings(settings, out string paramName, out string reason))
{
throw new ArgumentException(reason, paramName);
}

return settings;
}

/// <summary>
Expand Down