Skip to content

Don't crash on empty query string parameter name #1484

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 3 commits into from
Feb 28, 2024
Merged

Don't crash on empty query string parameter name #1484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8803e4
Return proper response for empty parameter name
verdie-g Feb 26, 2024
110d563
Address PR comments
verdie-g Feb 26, 2024
a6c2e17
Address comments
verdie-g Feb 27, 2024
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
5 changes: 5 additions & 0 deletions src/JsonApiDotNetCore/QueryStrings/QueryStringReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ public void ReadAll(DisableQueryStringAttribute? disableQueryStringAttribute)

foreach ((string parameterName, StringValues parameterValue) in _queryStringAccessor.Query)
{
if (parameterName.Length == 0)
{
continue;
}

IQueryStringParameterReader? reader = _parameterReaders.FirstOrDefault(nextReader => nextReader.CanRead(parameterName));

if (reader != null)
Expand Down
18 changes: 18 additions & 0 deletions test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/QueryStringTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,24 @@ public async Task Can_use_unknown_query_string_parameter()
httpResponse.ShouldHaveStatusCode(HttpStatusCode.OK);
}

[Theory]
[InlineData("")]
[InlineData("bar")]
public async Task Can_use_empty_query_string_parameter_name(string parameterValue)
{
// Arrange
var options = (JsonApiOptions)_testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();
options.AllowUnknownQueryStringParameters = false;

string route = $"calendars?={parameterValue}";

// Act
(HttpResponseMessage httpResponse, Document _) = await _testContext.ExecuteGetAsync<Document>(route);

// Assert
httpResponse.ShouldHaveStatusCode(HttpStatusCode.OK);
}

[Theory]
[InlineData("filter")]
[InlineData("sort")]
Expand Down