Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-11-23 19:32:29 +01:00
Code Issues Releases Wiki Activity

Tweaked ListingResponseBuilder to help avoid future issues

Browse Source 
- Updated so none of the method mutate the query throughout the function
so that the query can be handled in a sane way, Since we were already
encountering issues due to internal method call order.
This commit is contained in:
Dan Brown 2020-04-25 22:15:59 +01:00
parent a17b82bdde
commit 2ec4ad1181
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
app/Api/ListingResponseBuilder.php
View File

@ -36,10 +36,10 @@ class ListingResponseBuilder
*/
public function toResponse()
{
$this->applyFiltering($this->query);
$filteredQuery = $this->filterQuery($this->query);
$total = $this->query->count();
$data = $this->fetchData();
$total = $filteredQuery->count();
$data = $this->fetchData($filteredQuery);
return response()->json([
'data' => $data,
@ -50,22 +50,22 @@ class ListingResponseBuilder
/**
* Fetch the data to return in the response.
*/
protected function fetchData(): Collection
protected function fetchData(Builder $query): Collection
{
$this->applyCountAndOffset($this->query);
$this->applySorting($this->query);
return $this->query->get($this->fields);
$query = $this->countAndOffsetQuery($query);
$query = $this->sortQuery($query);
return $query->get($this->fields);
}
/**
* Apply any filtering operations found in the request.
*/
protected function applyFiltering(Builder $query)
protected function filterQuery(Builder $query): Builder
{
$query = clone $query;
$requestFilters = $this->request->get('filter', []);
if (!is_array($requestFilters)) {
return;
return $query;
}
$queryFilters = collect($requestFilters)->map(function ($value, $key) {
@ -74,7 +74,7 @@ class ListingResponseBuilder
return !is_null($value);
})->values()->toArray();
$query->where($queryFilters);
return $query->where($queryFilters);
}
/**
@ -102,8 +102,9 @@ class ListingResponseBuilder
* Apply sorting operations to the query from given parameters
* otherwise falling back to the first given field, ascending.
*/
protected function applySorting(Builder $query)
protected function sortQuery(Builder $query): Builder
{
$query = clone $query;
$defaultSortName = $this->fields[0];
$direction = 'asc';
@ -117,20 +118,21 @@ class ListingResponseBuilder
$sortName = $defaultSortName;
}
$query->orderBy($sortName, $direction);
return $query->orderBy($sortName, $direction);
}
/**
* Apply count and offset for paging, based on params from the request while falling
* back to system defined default, taking the max limit into account.
*/
protected function applyCountAndOffset(Builder $query)
protected function countAndOffsetQuery(Builder $query): Builder
{
$query = clone $query;
$offset = max(0, $this->request->get('offset', 0));
$maxCount = config('api.max_item_count');
$count = $this->request->get('count', config('api.default_item_count'));
$count = max(min($maxCount, $count), 1);
$query->skip($offset)->take($count);
return $query->skip($offset)->take($count);
}
}