Skip to content

Global config structure was developed for DynamicQueryAttribute. #45

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.

Sign up for GitHub

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
halilsafakkilic wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Global config structure was developed for DynamicQueryAttribute. #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 27 additions & 14 deletions DynamicQueryBuilder.UnitTests/DynamicQueryAttributeTests/OnActionExecutingTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ namespace DynamicQueryBuilder.UnitTests.DynamicQueryAttributeTests
{
public class OnActionExecutingTests : TestBase
{
private const int _defaultMaxCountSize = 100;
private const bool _defaultIncludeDataSetCount = true;
private const PaginationBehaviour _defaultPaginationBehaviour = PaginationBehaviour.GetMax;

[Fact]
public void OnActionExecutingShouldModifyDynamicQueryOptionsActionParameterWhenItsPresent()
{
Expand All @@ -53,19 +49,32 @@ public void ShouldSetGivenCtorValues()
var parameterlessInstance = new DynamicQueryAttribute();
var parameteredInstance = new DynamicQueryAttribute(200, false, PaginationBehaviour.Throw);

Assert.Equal(parameterlessInstance._maxCountSize, _defaultMaxCountSize);
Assert.Equal(parameterlessInstance._includeDataSetCountToPagination, _defaultIncludeDataSetCount);
Assert.Equal(parameterlessInstance._exceededPaginationCountBehaviour, _defaultPaginationBehaviour);
Assert.Equal(parameterlessInstance._maxCountSize, null);
Assert.Equal(parameterlessInstance._includeDataSetCountToPagination, null);
Assert.Equal(parameterlessInstance._exceededPaginationCountBehaviour, null);

Assert.Equal(parameteredInstance._maxCountSize, changedMaxCountSize);
Assert.Equal(parameteredInstance._includeDataSetCountToPagination, changedIncludedataSetCount);
Assert.Equal(parameteredInstance._exceededPaginationCountBehaviour, changedPaginationBehaviour);
}

[Fact]
public void ShouldNotSetCTorValuesWhenApplyGlobalFilter()
{
var defaultInstance = new DynamicQueryAttribute();
string queryExceedingMaxCount = DYNAMIC_QUERY_STRING.Replace("count=10", $"count={DynamicQueryAttributeGlobalConfig.MaxCountSize + 1}");
Copy link
Contributor

@cyilcode cyilcode Sep 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as i understand we are missing integration tests here. Can we please add those as well ?

DynamicQueryOptions executedOptions = ExecuteAction(defaultInstance, queryExceedingMaxCount);

Assert.Equal(DynamicQueryAttributeGlobalConfig.IncludeDataSetCountToPagination, executedOptions.PaginationOption.AssignDataSetCount);
Assert.Equal(DynamicQueryAttributeGlobalConfig.MaxCountSize, executedOptions.PaginationOption.Count);
}

[Fact]
public void ShouldSetGivenAssignDataSetCountWhenOptionsNotNull()
{
bool changedIncludeDataSetCount = !_defaultIncludeDataSetCount;
DynamicQueryAttributeGlobalConfig.LoadDefaultConfigs();

bool changedIncludeDataSetCount = !DynamicQueryAttributeGlobalConfig.IncludeDataSetCountToPagination;
var parameterlessInstance = new DynamicQueryAttribute(includeDataSetCountToPagination: changedIncludeDataSetCount);
DynamicQueryOptions executedOptions = ExecuteAction(parameterlessInstance);
Assert.Equal(executedOptions.PaginationOption.AssignDataSetCount, changedIncludeDataSetCount);
Expand All @@ -74,22 +83,26 @@ public void ShouldSetGivenAssignDataSetCountWhenOptionsNotNull()
[Fact]
public void ShouldSetCountToMaxWhenCountExceedsAndOptionsWereSetToGetMaxOrDefault()
{
var behaviourSetInstance = new DynamicQueryAttribute(exceededPaginationCountBehaviour: PaginationBehaviour.GetMax);
int maxCountSizeDefination = 10;

var behaviourSetInstance = new DynamicQueryAttribute(exceededPaginationCountBehaviour: PaginationBehaviour.GetMax, maxCountSize: maxCountSizeDefination);
var defaultBehaviourInstance = new DynamicQueryAttribute();
string queryExceedingMaxCount = DYNAMIC_QUERY_STRING.Replace("count=10", $"count={_defaultMaxCountSize + 1}");
string queryExceedingMaxCount = DYNAMIC_QUERY_STRING.Replace("count=10", $"count={maxCountSizeDefination + 1}");

DynamicQueryOptions executedOptionsWithSetOptions = ExecuteAction(behaviourSetInstance, queryExceedingMaxCount);
DynamicQueryOptions executedOptionsWithDefaultOptions = ExecuteAction(defaultBehaviourInstance, queryExceedingMaxCount);

Assert.Equal(executedOptionsWithSetOptions.PaginationOption.Count, _defaultMaxCountSize);
Assert.Equal(executedOptionsWithDefaultOptions.PaginationOption.Count, _defaultMaxCountSize);
Assert.Equal(executedOptionsWithSetOptions.PaginationOption.Count, maxCountSizeDefination);
Assert.Equal(executedOptionsWithDefaultOptions.PaginationOption.Count, maxCountSizeDefination + 1);
}

[Fact]
public void ShouldSetCountToMaxWhenCountExceedsAndOptionsWereSetToThrow()
{
var behaviourSetInstance = new DynamicQueryAttribute(exceededPaginationCountBehaviour: PaginationBehaviour.Throw);
string queryExceedingMaxCount = DYNAMIC_QUERY_STRING.Replace("count=10", $"count={_defaultMaxCountSize + 1}");
int maxCountSizeDefination = 10;

var behaviourSetInstance = new DynamicQueryAttribute(exceededPaginationCountBehaviour: PaginationBehaviour.Throw, maxCountSize: maxCountSizeDefination);
string queryExceedingMaxCount = DYNAMIC_QUERY_STRING.Replace("count=10", $"count={maxCountSizeDefination + 1}");
Assert.Throws<MaximumResultSetExceededException>(() => { ExecuteAction(behaviourSetInstance, queryExceedingMaxCount); });
}

Expand Down
31 changes: 18 additions & 13 deletions DynamicQueryBuilder/DynamicQueryAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,22 @@ namespace DynamicQueryBuilder
/// </summary>
public sealed class DynamicQueryAttribute : ActionFilterAttribute
{
internal readonly int _maxCountSize = 0;
internal readonly bool _includeDataSetCountToPagination;
internal readonly PaginationBehaviour _exceededPaginationCountBehaviour;
internal readonly int? _maxCountSize;
internal readonly bool? _includeDataSetCountToPagination;
internal readonly PaginationBehaviour? _exceededPaginationCountBehaviour;

/// <summary>
/// Initializes a new instance of the <see cref="DynamicQueryAttribute"/> class.
/// DynamicQueryAttributeGlobalConfig definations is used for parameters with a null value.
/// Also, Finds and constructs DynamicQueryOptions class in the parameters.
/// </summary>
/// <param name="maxCountSize">Max data set count for the result set.</param>
/// <param name="includeDataSetCountToPagination">Includes the total data set count to the options class.</param>
/// <param name="exceededPaginationCountBehaviour">Behaviour when the requested data set count greater than max count size.</param>
/// <param name="resolveFromParameter">Resolves the dynamic query string from the given query parameter value.</param>
public DynamicQueryAttribute(
int maxCountSize = 100,
bool includeDataSetCountToPagination = true,
PaginationBehaviour exceededPaginationCountBehaviour = PaginationBehaviour.GetMax)
int? maxCountSize = null,
bool? includeDataSetCountToPagination = null,
PaginationBehaviour? exceededPaginationCountBehaviour = null)
{
_maxCountSize = maxCountSize;
_includeDataSetCountToPagination = includeDataSetCountToPagination;
Expand Down Expand Up @@ -100,18 +100,23 @@ public override void OnActionExecuting(ActionExecutingContext context)

parsedOptions.UsesCaseInsensitiveSource = dqbSettings.UsesCaseInsensitiveSource;
parsedOptions.IgnorePredefinedOrders = dqbSettings.IgnorePredefinedOrders;

bool includeDataSetCountToPagination = _includeDataSetCountToPagination == null ? DynamicQueryAttributeGlobalConfig.IncludeDataSetCountToPagination : _includeDataSetCountToPagination.GetValueOrDefault();
if (parsedOptions.PaginationOption != null)
{
parsedOptions.PaginationOption.AssignDataSetCount = _includeDataSetCountToPagination;
if (parsedOptions.PaginationOption.Count > _maxCountSize)
parsedOptions.PaginationOption.AssignDataSetCount = includeDataSetCountToPagination;

int maxCountSize = _maxCountSize == null ? DynamicQueryAttributeGlobalConfig.MaxCountSize : _maxCountSize.GetValueOrDefault();
if (parsedOptions.PaginationOption.Count > maxCountSize)
{
if (_exceededPaginationCountBehaviour == PaginationBehaviour.GetMax)
PaginationBehaviour exceededPaginationCountBehaviour = _exceededPaginationCountBehaviour == null ? DynamicQueryAttributeGlobalConfig.ExceededPaginationCountBehaviour : _exceededPaginationCountBehaviour.GetValueOrDefault();
if (exceededPaginationCountBehaviour == PaginationBehaviour.GetMax)
{
parsedOptions.PaginationOption.Count = _maxCountSize;
parsedOptions.PaginationOption.Count = maxCountSize;
}
else
{
throw new MaximumResultSetExceededException($"Given count {parsedOptions.PaginationOption.Count} exceeds the maximum amount");
throw new MaximumResultSetExceededException($"Given count {parsedOptions.PaginationOption.Count} exceeds the maximum amount of {maxCountSize}");
}
}
else if (parsedOptions.PaginationOption.Count <= 0)
Expand All @@ -124,7 +129,7 @@ public override void OnActionExecuting(ActionExecutingContext context)
parsedOptions.PaginationOption.Offset = 0;
}
}
else if (_includeDataSetCountToPagination && parsedOptions.PaginationOption == null)
else if (includeDataSetCountToPagination && parsedOptions.PaginationOption == null)
{
parsedOptions.PaginationOption = new PaginationOption
{
Expand Down
22 changes: 22 additions & 0 deletions DynamicQueryBuilder/DynamicQueryAttributeGlobalConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
using DynamicQueryBuilder.Models.Enums;

namespace DynamicQueryBuilder
{
public static class DynamicQueryAttributeGlobalConfig
Copy link
Contributor

@cyilcode cyilcode Sep 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As much as i like the simple development aspect of this static context, this probably will come with its prices like thread safety and all. Instead, i would advise to use dependency injection through the ActionContext and get our settings from there. Here is an example of that.

Edit: Static objects also come with testing challenges since we dont run tests sequentially so if that would create concurrency issues as well.

{
internal static readonly int MaxCountSizeDefault = 100;
internal static readonly bool IncludeDataSetCountToPaginationDefault = true;
internal static readonly PaginationBehaviour ExceededPaginationCountBehaviourDefault = PaginationBehaviour.GetMax;

public static int MaxCountSize { get; set; } = MaxCountSizeDefault;
public static bool IncludeDataSetCountToPagination { get; set; } = IncludeDataSetCountToPaginationDefault;
public static PaginationBehaviour ExceededPaginationCountBehaviour { get; set; } = ExceededPaginationCountBehaviourDefault;

public static void LoadDefaultConfigs()
{
MaxCountSize = MaxCountSizeDefault;
IncludeDataSetCountToPagination = IncludeDataSetCountToPaginationDefault;
ExceededPaginationCountBehaviour = ExceededPaginationCountBehaviourDefault;
}
}
}
2 changes: 2 additions & 0 deletions docs/dqb.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,8 @@ int totalDataSetCount = paginationOption.DataSetCount;
Web development is actually where DQB shines the most. DQB comes with an
~ActionFilter~ that can parse HTTP queries into ~DynamicQueryOptions~ class.

If you want change global config for ~ActionFilter~, this can be use ~DynamicQueryAttributeGlobalConfig~.

** Setting up DynamicQueryBuilderSettings
This is a singleton object that can hold static configurations for DQB like
operation shortcodes, query resolution methods and data source case sensitivity.
Expand Down