Skip to content

refactor(controller): dedupe filter+include logic between `JsonApiQue… #132

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
Erlend Ellefsen (erlendellefsen) merged 1 commit into from
May 7, 2026
Merged

refactor(controller): dedupe filter+include logic between `JsonApiQue… #132

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
89 changes: 30 additions & 59 deletions JsonApiToolkit/Controllers/JsonApiController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,8 @@ string resourceType
IQueryable<T> filteredQuery = ApplyFiltersAndIncludes(
queryable,
parameters,
mappedIncludes
mappedIncludes,
paginating: parameters.Pagination != null
);

if (parameters.Sort?.Count > 0)
Expand Down Expand Up @@ -280,53 +281,15 @@ protected async Task<JsonApiQueryResult<T>> BuildJsonApiQueryAsync<T>(
parameters.Include
);

if (parameters.Include?.Count > 0 && mappedIncludes.Count == 0)
{
Logger.LogWarning(
"No valid includes for {EntityType}. Requested: {Includes}",
typeof(T).Name,
string.Join(", ", parameters.Include)
);
}
LogInvalidIncludes<T>(parameters, mappedIncludes);

var (mainFilters, includeFilters) = IncludeFilterParser.SeparateIncludeFilters(
parameters.Filter,
parameters.Include
IQueryable<T> processedQuery = ApplyFiltersAndIncludes(
queryable,
parameters,
mappedIncludes,
paginating: false
);

IQueryable<T> processedQuery = queryable;

// Apply main entity filters
if (mainFilters != null)
processedQuery = processedQuery.ApplyFilters(mainFilters, Logger);

// Apply includes (with or without filters)
if (includeFilters.Count > 0)
{
Logger.LogDebug(
"Applying {FilterCount} filtered includes for {EntityType}",
includeFilters.Count,
typeof(T).Name
);
processedQuery = processedQuery.ApplyFilteredIncludes(
mappedIncludes,
includeFilters,
Logger
);
}
else if (mappedIncludes.Count > 0)
{
// Use standard includes (no pagination optimization needed since we're not paginating)
processedQuery = processedQuery.ApplyIncludes(mappedIncludes);

Logger.LogDebug(
"Applied {IncludeCount} includes for {EntityType}",
mappedIncludes.Count,
typeof(T).Name
);
}

// Apply sorting
if (parameters.Sort?.Count > 0)
processedQuery = processedQuery.ApplySorting(parameters.Sort, Logger);

Expand Down Expand Up @@ -435,20 +398,17 @@ private void LogQueryParameters<T>(QueryParameters parameters, List<string> mapp
);
}

if (parameters.Include?.Count > 0 && mappedIncludes.Count == 0)
{
Logger.LogWarning(
"No valid includes for {EntityType}. Requested: {Includes}",
typeof(T).Name,
string.Join(", ", parameters.Include)
);
}
LogInvalidIncludes<T>(parameters, mappedIncludes);
}

// When `paginating` is true, includes use single-query mode to avoid the
// EF Core warning/exception triggered by split-query + Skip/Take. Otherwise
// split-query is preferred to avoid cartesian explosion on collection includes.
private IQueryable<T> ApplyFiltersAndIncludes<T>(
IQueryable<T> queryable,
QueryParameters parameters,
List<string> mappedIncludes
List<string> mappedIncludes,
bool paginating
)
where T : class
{
Expand Down Expand Up @@ -477,22 +437,33 @@ List<string> mappedIncludes
}
else if (mappedIncludes.Count > 0)
{
filteredQuery =
parameters.Pagination != null
? filteredQuery.ApplyIncludesSingleQuery(mappedIncludes)
: filteredQuery.ApplyIncludes(mappedIncludes);
filteredQuery = paginating
? filteredQuery.ApplyIncludesSingleQuery(mappedIncludes)
: filteredQuery.ApplyIncludes(mappedIncludes);

Logger.LogDebug(
"Applied {IncludeCount} includes for {EntityType} using {QueryType}",
mappedIncludes.Count,
typeof(T).Name,
parameters.Pagination != null ? "SingleQuery" : "SplitQuery"
paginating ? "SingleQuery" : "SplitQuery"
);
}

return filteredQuery;
}

private void LogInvalidIncludes<T>(QueryParameters parameters, List<string> mappedIncludes)
{
if (parameters.Include?.Count > 0 && mappedIncludes.Count == 0)
{
Logger.LogWarning(
"No valid includes for {EntityType}. Requested: {Includes}",
typeof(T).Name,
string.Join(", ", parameters.Include)
);
}
}

private static void EnforceStrictPagination(
JsonApiOptions options,
QueryParameters parameters,
Expand Down
Loading