Skip to content

perf(filter)!: send filter values as parameters by default #125

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

perf(filter)!: send filter values as parameters by default #125

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
16 changes: 8 additions & 8 deletions QueryKit.IntegrationTests/Tests/FilterParameterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ namespace QueryKit.IntegrationTests.Tests;

public class FilterParameterTests() : TestBase
{
private static readonly QueryKitConfiguration ParameterizedConfig =
new(settings => settings.ParameterizeFilterValues = true);
private static readonly QueryKitConfiguration LiteralConfig =
new(settings => settings.ParameterizeFilterValues = false);

[Theory]
[InlineData("""Title == "lamb" """, """Title == "chicken" """)]
Expand Down Expand Up @@ -48,7 +48,7 @@ public async Task in_list_is_one_array_parameter_and_still_filters()
await testingServiceScope.InsertAsync(lamb, chicken, beef);

var input = $"""Title ^^* ["{lamb.Title!.ToUpper()}", "{chicken.Title}"]""";
var query = testingServiceScope.DbContext().People.ApplyQueryKitFilter(input, ParameterizedConfig);
var query = testingServiceScope.DbContext().People.ApplyQueryKitFilter(input);
var people = await query.ToListAsync();

SqlWithoutParameterValues(query).Should().Contain("= ANY (@");
Expand All @@ -60,18 +60,18 @@ public async Task in_list_is_one_array_parameter_and_still_filters()
[InlineData("Age > 30", "> 30")]
[InlineData("Date == 2022-07-01", "DATE '2022-07-01'")]
[InlineData("(Age + 5) > 30", "+ 5")]
public void filter_values_are_sql_literals_by_default(string input, string expectedLiteral)
public void filter_values_are_sql_literals_when_parameters_are_off(string input, string expectedLiteral)
{
var testingServiceScope = new TestingServiceScope();

var sql = testingServiceScope.DbContext().People.ApplyQueryKitFilter(input).ToQueryString();
var sql = testingServiceScope.DbContext().People.ApplyQueryKitFilter(input, LiteralConfig).ToQueryString();

sql.Should().NotContain("@");
sql.Should().Contain(expectedLiteral);
}

[Fact]
public async Task in_list_is_a_literal_list_by_default_and_still_filters()
public async Task in_list_is_a_literal_list_when_parameters_are_off_and_still_filters()
{
var testingServiceScope = new TestingServiceScope();
var lamb = new FakeTestingPersonBuilder().WithTitle($"lamb {Guid.NewGuid()}").Build();
Expand All @@ -80,15 +80,15 @@ public async Task in_list_is_a_literal_list_by_default_and_still_filters()
await testingServiceScope.InsertAsync(lamb, chicken, beef);

var input = $"""Title ^^ ["{lamb.Title}", "{chicken.Title}"]""";
var query = testingServiceScope.DbContext().People.ApplyQueryKitFilter(input);
var query = testingServiceScope.DbContext().People.ApplyQueryKitFilter(input, LiteralConfig);
var people = await query.ToListAsync();

query.ToQueryString().Should().Contain($"IN ('{lamb.Title}', '{chicken.Title}')");
people.Select(x => x.Id).Should().BeEquivalentTo(new[] { lamb.Id, chicken.Id });
}

private static string SqlWithoutParameterValues(TestingServiceScope testingServiceScope, string input)
=> SqlWithoutParameterValues(testingServiceScope.DbContext().People.ApplyQueryKitFilter(input, ParameterizedConfig));
=> SqlWithoutParameterValues(testingServiceScope.DbContext().People.ApplyQueryKitFilter(input));

// ToQueryString() writes each parameter value in a "-- @p='...'" comment line before the SQL.
private static string SqlWithoutParameterValues(IQueryable<TestingPerson> query)
Expand Down
2 changes: 1 addition & 1 deletion QueryKit.UnitTests/FilterParserTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public void complex_with_lots_of_types()

var filterExpression = FilterParser.ParseFilter<TestingPerson>(input);
filterExpression.ToDisplayString().Should()
.Be(""""x => (((((((((x.Title != null) AndAlso x.Title.ToLower().Contains("waffle & chicken".ToLower())) AndAlso (x.Age > 30)) OrElse (x.Id == aa648248-cb69-4217-ac95-d7484795afb2)) OrElse (x.Title == "lamb")) OrElse (x.Title == null)) AndAlso ((x.Age < 18) OrElse ((x.BirthMonth == new Nullable`1(January)) AndAlso ((x.Title != null) AndAlso x.Title.StartsWith("ally"))))) OrElse (x.Rating > 3.5)) OrElse ((x.SpecificDate == new Nullable`1(new DateTimeOffset(637922304030000000, 00:00:00))) AndAlso ((x.Date == new Nullable`1(new DateOnly(2022, 7, 1))) OrElse (x.Time == new Nullable`1(new TimeOnly(0, 0, 3, 0, 0))))))"""");
.Be(""""x => (((((((((x.Title != null) AndAlso x.Title.ToLower().Contains("waffle & chicken".ToLower())) AndAlso (x.Age > 30)) OrElse (x.Id == aa648248-cb69-4217-ac95-d7484795afb2)) OrElse (x.Title == "lamb")) OrElse (x.Title == null)) AndAlso ((x.Age < 18) OrElse ((x.BirthMonth == January) AndAlso ((x.Title != null) AndAlso x.Title.StartsWith("ally"))))) OrElse (x.Rating > 3.5)) OrElse ((x.SpecificDate == new Nullable`1(new DateTimeOffset(637922304030000000, 00:00:00))) AndAlso ((x.Date == new Nullable`1(new DateOnly(2022, 7, 1))) OrElse (x.Time == new Nullable`1(new TimeOnly(0, 0, 3, 0, 0))))))"""");
}

[Fact]
Expand Down
16 changes: 8 additions & 8 deletions QueryKit.UnitTests/FilterValueParameterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ namespace QueryKit.UnitTests;

public class FilterValueParameterTests
{
private static readonly QueryKitConfiguration ParameterizedConfig =
new(settings => settings.ParameterizeFilterValues = true);
private static readonly QueryKitConfiguration LiteralConfig =
new(settings => settings.ParameterizeFilterValues = false);

[Theory]
[InlineData("""Title == "lamb" """)]
Expand All @@ -31,7 +31,7 @@ public class FilterValueParameterTests
[InlineData("(Age + 5) > 30")]
public void filter_values_are_field_reads_so_ef_core_sends_them_as_parameters(string input)
{
var filterExpression = FilterParser.ParseFilter<TestingPerson>(input, ParameterizedConfig);
var filterExpression = FilterParser.ParseFilter<TestingPerson>(input);

var constants = new ConstantCollector();
constants.Visit(filterExpression);
Expand All @@ -50,9 +50,9 @@ public void filter_values_are_field_reads_so_ef_core_sends_them_as_parameters(st
[InlineData("Date == 2022-07-01", "x => (x.Date == new Nullable`1(new DateOnly(2022, 7, 1)))")]
[InlineData("""Time == "00:00:03.123456" """, "x => (x.Time == new Nullable`1(new TimeOnly(0, 0, 3, 123, 456)))")]
[InlineData("(Age + 5) > 30", "x => ((x.Age + Convert(5, Nullable`1)) > Convert(30, Nullable`1))")]
public void filter_values_are_constants_by_default(string input, string expected)
public void filter_values_are_constants_when_parameters_are_off(string input, string expected)
{
var filterExpression = FilterParser.ParseFilter<TestingPerson>(input);
var filterExpression = FilterParser.ParseFilter<TestingPerson>(input, LiteralConfig);

filterExpression.ToString().Should().Be(expected);
}
Expand All @@ -64,9 +64,9 @@ public void filter_values_are_constants_by_default(string input, string expected
[InlineData("""Title ^^* ["lamb", "chicken"]""")]
[InlineData("Age ^^ [18, 30]")]
[InlineData("(Age + 5) > 30")]
public void filter_values_do_not_use_the_holder_by_default(string input)
public void filter_values_do_not_use_the_holder_when_parameters_are_off(string input)
{
var filterExpression = FilterParser.ParseFilter<TestingPerson>(input);
var filterExpression = FilterParser.ParseFilter<TestingPerson>(input, LiteralConfig);

var constants = new ConstantCollector();
constants.Visit(filterExpression);
Expand All @@ -79,7 +79,7 @@ public void filter_values_do_not_use_the_holder_by_default(string input)
[Fact]
public void filter_values_keep_their_value_and_type()
{
var filterExpression = FilterParser.ParseFilter<TestingPerson>("""Time == "00:00:03.123456" """, ParameterizedConfig);
var filterExpression = FilterParser.ParseFilter<TestingPerson>("""Time == "00:00:03.123456" """);

var comparison = (BinaryExpression)filterExpression.Body;
var read = (MemberExpression)comparison.Right;
Expand Down
6 changes: 3 additions & 3 deletions QueryKit/Configuration/QueryKitSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ public class QueryKitSettings
public CaseInsensitiveMode CaseInsensitiveComparison { get; set; } = CaseInsensitiveMode.Lower;

/// <summary>
/// When true, filter values are field reads that EF Core sends as SQL parameters. When false (the default),
/// filter values are constants that EF Core writes into the SQL as literals.
/// When true (the default), filter values are field reads that EF Core sends as SQL parameters. When false,
/// filter values are constants that EF Core writes into the SQL as literals, the same as v1.14.2.
/// </summary>
public bool ParameterizeFilterValues { get; set; }
public bool ParameterizeFilterValues { get; set; } = true;

/// <summary>
/// What the filter parser does with a clause on a prevented or unknown property. The default is
Expand Down
2 changes: 1 addition & 1 deletion QueryKit/FilterParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public static Expression<Func<T, bool>> ParseFilter<T>(string input, IQueryKitCo
var parameter = Expression.Parameter(typeof(T), "x");
Expression expr;
var parameterizeBefore = FilterValue.Parameterize;
FilterValue.Parameterize = config is QueryKitConfiguration { ParameterizeFilterValues: true };
FilterValue.Parameterize = (config as QueryKitConfiguration)?.ParameterizeFilterValues ?? true;
try
{
expr = ExprParser<T>(parameter, config).End().Parse(input);
Expand Down
Loading