Skip to content

FOUR-15317: Improve performance of task-related saved searches (b) #6806

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
ryancooley merged 3 commits into from
May 1, 2024
Merged

FOUR-15317: Improve performance of task-related saved searches (b) #6806

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
b72df8c
Added pagination to query for TaskController for better performance
runyan-co Apr 30, 2024
b00c6d0
Add pagination conditionally
runyan-co May 1, 2024
fd62576
Conditional pagination
runyan-co May 1, 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
14 changes: 10 additions & 4 deletions ProcessMaker/Http/Controllers/Api/TaskController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,12 @@ public function index(Request $request, $getTotal = false, User $user = null)
// Apply filter overdue
$query->overdue($request->input('overdue'));

// If we should manually add pagination to the
// query in advance (also used by saved search)
if ($this->isPaginationEnabled()) {
$query->paginate($request->input('per_page', 10));
}

try {
$response = $query->get();
} catch (QueryException $e) {
Expand Down Expand Up @@ -263,15 +269,15 @@ private function handleQueryException($e)
{
$regex = '~Column not found: 1054 Unknown column \'(.*?)\' in \'where clause\'~';
preg_match($regex, $e->getMessage(), $m);

$message = __('PMQL Is Invalid.');

if (count($m) > 1) {
$message .= ' ' . __('Column not found: ') . '"' . $m[1] . '"';
}

\Log::error($e->getMessage());

return response([
'message' => $message,
], 422);
Expand Down
30 changes: 30 additions & 0 deletions ProcessMaker/Traits/TaskControllerIndexMethods.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,36 @@

trait TaskControllerIndexMethods
{
/**
* Manually enable paginated results from the
* index method()
*
* @return void
*/
public function enableIndexPagination(): void
{
static::$paginate = true;
}

/**
* Determine if pagination was manually set for the
* index() method results
*
* @return bool
*/
public function isPaginationEnabled(): bool
{
return static::$paginate === true;
}

/**
* Used by saved search to paginate the results
* from the index() method
*
* @var bool
*/
protected static bool $paginate = false;

private function indexBaseQuery($request)
{
$query = ProcessRequestToken::with(['processRequest', 'user', 'draft']);
Expand Down