Skip to content

Fixed: splitting on comma in legacy filter notation #825

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

Merged
merged 1 commit into from
Sep 15, 2020
Merged

Fixed: splitting on comma in legacy filter notation #825

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
20 changes: 19 additions & 1 deletion src/JsonApiDotNetCore/QueryStrings/Internal/FilterQueryStringParameterReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,30 @@ public virtual void Read(string parameterName, StringValues parameterValues)
{
_lastParameterName = parameterName;

foreach (string parameterValue in parameterValues)
foreach (string parameterValue in ExtractParameterValues(parameterName, parameterValues))
{
ReadSingleValue(parameterName, parameterValue);
}
}

private IEnumerable<string> ExtractParameterValues(string parameterName, StringValues parameterValues)
{
foreach (string parameterValue in parameterValues)
{
if (_options.EnableLegacyFilterNotation)
{
foreach (string condition in _legacyConverter.ExtractConditions(parameterName, parameterValue))
{
yield return condition;
}
}
else
{
yield return parameterValue;
}
}
}

private void ReadSingleValue(string parameterName, string parameterValue)
{
try
Expand Down
17 changes: 17 additions & 0 deletions src/JsonApiDotNetCore/QueryStrings/Internal/LegacyFilterNotationConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,23 @@ public sealed class LegacyFilterNotationConverter
["like:"] = Keywords.Contains
};

public IEnumerable<string> ExtractConditions(string parameterName, string parameterValue)
{
if (parameterValue.StartsWith(ExpressionPrefix, StringComparison.Ordinal) ||
parameterValue.StartsWith(InPrefix, StringComparison.Ordinal) ||
parameterValue.StartsWith(NotInPrefix, StringComparison.Ordinal))
{
yield return parameterValue;
}
else
{
foreach (string condition in parameterValue.Split(','))
{
yield return condition;
}
}
}

public (string parameterName, string parameterValue) Convert(string parameterName, string parameterValue)
{
if (parameterName == null) throw new ArgumentNullException(nameof(parameterName));
Expand Down
4 changes: 3 additions & 1 deletion test/UnitTests/QueryStringParameters/LegacyFilterParseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ public void Reader_Read_Fails(string parameterName, string parameterValue, strin

[Theory]
[InlineData("filter[caption]", "Brian O'Quote", "equals(caption,'Brian O''Quote')")]
[InlineData("filter[caption]", "using,comma", "equals(caption,'using,comma')")]
[InlineData("filter[caption]", "am&per-sand", "equals(caption,'am&per-sand')")]
[InlineData("filter[caption]", "2017-08-15T22:43:47.0156350-05:00", "equals(caption,'2017-08-15T22:43:47.0156350-05:00')")]
[InlineData("filter[caption]", "eq:1", "equals(caption,'1')")]
Expand All @@ -77,6 +76,9 @@ public void Reader_Read_Fails(string parameterName, string parameterValue, strin
[InlineData("filter", "expr:equals(author,null)", "equals(author,null)")]
[InlineData("filter", "expr:has(author.articles)", "has(author.articles)")]
[InlineData("filter", "expr:equals(count(author.articles),'1')", "equals(count(author.articles),'1')")]
[InlineData("filter[caption]", "using,comma", "or(equals(caption,'using'),equals(caption,'comma'))")]
[InlineData("filter[caption]", "like:First,Second", "or(contains(caption,'First'),equals(caption,'Second'))")]
[InlineData("filter[caption]", "like:First,like:Second", "or(contains(caption,'First'),contains(caption,'Second'))")]
public void Reader_Read_Succeeds(string parameterName, string parameterValue, string expressionExpected)
{
// Act
Expand Down