Skip to content

Implement a high performance paginator #176

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
Oct 3, 2024
Merged

Implement a high performance paginator #176

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
67559d4
Implement cursor pagination to improve page loading time.
denydias Sep 23, 2024
fb56e5a
Don't print itens count when cursor paginate is enabled.
denydias Sep 23, 2024
82f943f
Don't print itens count when cursor paginate is enabled on index and …
denydias Sep 23, 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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ LARAVEL_LOGGER_USER_MODEL=App\User
LARAVEL_LOGGER_USER_ID_FIELD=id
LARAVEL_LOGGER_DISABLE_ROUTES=false
LARAVEL_LOGGER_PAGINATION_ENABLED=true
LARAVEL_LOGGER_CURSOR_PAGINATION_ENABLED=false
LARAVEL_LOGGER_PAGINATION_PER_PAGE=25
LARAVEL_LOGGER_DATATABLES_ENABLED=true
LARAVEL_LOGGER_ENABLE_SEARCH=true
Expand Down Expand Up @@ -286,6 +287,10 @@ Route::group(['prefix' => 'activity', 'namespace' => 'jeremykenedy\LaravelLogger

adding dynamic search fields (description , user, URL , method and ip address)

### High Performance Paginator

When dealing with millions activity records, default behavior of not paginate records or [Laravel's paginator](https://laravel.com/docs/pagination#paginating-eloquent-results) (enabled `LARAVEL_LOGGER_PAGINATION_ENABLED=true`) may lead to huge performance penalties. For that use case you may set `LARAVEL_LOGGER_CURSOR_PAGINATION_ENABLED=true` to enable [Laravel's Cursor Pagination](https://laravel.com/docs/pagination#cursor-pagination) feature. This will heavily improve Laravel Logger page loading time. If you choose to do so it's advisable to read [Cursor vs. Offset Pagination](https://laravel.com/docs/pagination#cursor-vs-offset-pagination) section on Laravel's documentation to get acquainted with Cursor Pagination limitations.

##### .env file
add these configurations to your .env file to control the logging search
```
Expand Down
24 changes: 20 additions & 4 deletions src/App/Http/Controllers/LaravelLoggerController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,14 @@ private function mapAdditionalDetails($collectionItems)
*/
public function showAccessLog(Request $request)
{
if (config('LaravelLogger.loggerPaginationEnabled')) {
if (config('LaravelLogger.loggerCursorPaginationEnabled')) {
$activities = config('LaravelLogger.defaultActivityModel')::orderBy('created_at', 'desc');
if (config('LaravelLogger.enableSearch')) {
$activities = $this->searchActivityLog($activities, $request);
}
$activities = $activities->cursorPaginate(config('LaravelLogger.loggerPaginationPerPage'))->withQueryString();
$totalActivities = 0;
} elseif (config('LaravelLogger.loggerPaginationEnabled')) {
$activities = config('LaravelLogger.defaultActivityModel')::orderBy('created_at', 'desc');
if (config('LaravelLogger.enableSearch')) {
$activities = $this->searchActivityLog($activities, $request);
Expand All @@ -76,7 +83,6 @@ public function showAccessLog(Request $request)
$totalActivities = $activities->total();
} else {
$activities = config('LaravelLogger.defaultActivityModel')::orderBy('created_at', 'desc');

if (config('LaravelLogger.enableSearch')) {
$activities = $this->searchActivityLog($activities, $request);
}
Expand Down Expand Up @@ -122,7 +128,12 @@ public function showAccessLogEntry(Request $request, $id)
$eventTime = Carbon::parse($activity->created_at);
$timePassed = $eventTime->diffForHumans();

if (config('LaravelLogger.loggerPaginationEnabled')) {
if (config('LaravelLogger.loggerCursorPaginationEnabled')) {
$userActivities = config('LaravelLogger.defaultActivityModel')::where('userId', $activity->userId)
->orderBy('created_at', 'desc')
->cursorPaginate(config('LaravelLogger.loggerPaginationPerPage'));
$totalUserActivities = 0;
} elseif (config('LaravelLogger.loggerPaginationEnabled')) {
$userActivities = config('LaravelLogger.defaultActivityModel')::where('userId', $activity->userId)
->orderBy('created_at', 'desc')
->paginate(config('LaravelLogger.loggerPaginationPerPage'));
Expand Down Expand Up @@ -175,7 +186,12 @@ public function clearActivityLog(Request $request)
*/
public function showClearedActivityLog()
{
if (config('LaravelLogger.loggerPaginationEnabled')) {
if (config('LaravelLogger.loggerCursorPaginationEnabled')) {
$activities = config('LaravelLogger.defaultActivityModel')::onlyTrashed()
->orderBy('created_at', 'desc')
->paginate(config('LaravelLogger.loggerPaginationPerPage'));
$totalActivities = 0;
} elseif (config('LaravelLogger.loggerPaginationEnabled')) {
$activities = config('LaravelLogger.defaultActivityModel')::onlyTrashed()
->orderBy('created_at', 'desc')
->paginate(config('LaravelLogger.loggerPaginationPerPage'));
Expand Down
1 change: 1 addition & 0 deletions src/config/laravel-logger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
|--------------------------------------------------------------------------
*/
'loggerPaginationEnabled' => env('LARAVEL_LOGGER_PAGINATION_ENABLED', true),
'loggerCursorPaginationEnabled' => env('LARAVEL_LOGGER_CURSOR_PAGINATION_ENABLED', false),
'loggerPaginationPerPage' => env('LARAVEL_LOGGER_PAGINATION_PER_PAGE', 25),

/*
Expand Down
8 changes: 5 additions & 3 deletions src/resources/views/logger/activity-log-cleared.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@
<div style="display: flex; justify-content: space-between; align-items: center;">
<span>
{!! trans('LaravelLogger::laravel-logger.dashboardCleared.title') !!}
<sup class="label">
{{ $totalActivities }} {!! trans('LaravelLogger::laravel-logger.dashboardCleared.subtitle') !!}
</sup>
@if(! config('LaravelLogger.loggerCursorPaginationEnabled'))
<sup class="label">
{{ $totalActivities }} {!! trans('LaravelLogger::laravel-logger.dashboardCleared.subtitle') !!}
</sup>
@endif
</span>
<div class="btn-group pull-right btn-group-xs">
<button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Expand Down
8 changes: 5 additions & 3 deletions src/resources/views/logger/activity-log-item.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,11 @@
<ul class="list-group">
<li class="list-group-item list-group-item-info">
{!! trans('LaravelLogger::laravel-logger.drilldown.title-user-activity') !!}
<span class="badge">
{{ $totalUserActivities }} {!! trans('LaravelLogger::laravel-logger.dashboard.subtitle') !!}
</span>
@if(! config('LaravelLogger.loggerCursorPaginationEnabled'))
<span class="badge">
{{ $totalUserActivities }} {!! trans('LaravelLogger::laravel-logger.dashboard.subtitle') !!}
</span>
@endif
</li>
<li class="list-group-item">
@include('LaravelLogger::logger.partials.activity-table', ['activities' => $userActivities])
Expand Down
26 changes: 15 additions & 11 deletions src/resources/views/logger/activity-log.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,13 @@

<span>
{!! trans('LaravelLogger::laravel-logger.dashboard.title') !!}
<small>
<sup class="label label-default">
{{ $totalActivities }} {!! trans('LaravelLogger::laravel-logger.dashboard.subtitle') !!}
</sup>
</small>
@if(! config('LaravelLogger.loggerCursorPaginationEnabled'))
<small>
<sup class="label label-default">
{{ $totalActivities }} {!! trans('LaravelLogger::laravel-logger.dashboard.subtitle') !!}
</sup>
</small>
@endif
</span>

<div class="btn-group pull-right btn-group-xs">
Expand Down Expand Up @@ -120,12 +122,14 @@

@else
{!! trans('LaravelLogger::laravel-logger.dashboard.title') !!}
<span class="pull-right label label-default">
{{ $totalActivities }}
<span class="hidden-sms">
{!! trans('LaravelLogger::laravel-logger.dashboard.subtitle') !!}
</span>
</span>
@if(! config('LaravelLogger.loggerCursorPaginationEnabled'))
<span class="pull-right label label-default">
{{ $totalActivities }}
<span class="hidden-sms">
{!! trans('LaravelLogger::laravel-logger.dashboard.subtitle') !!}
</span>
</span>
@endif
@endif

</div>
Expand Down
8 changes: 7 additions & 1 deletion src/resources/views/logger/partials/activity-table.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,13 @@
</table>
</div>

@if(config('LaravelLogger.loggerPaginationEnabled'))
@if(config('LaravelLogger.loggerCursorPaginationEnabled'))
<div class="text-center">
<div class="d-flex justify-content-center">
{!! $activities->links() !!}
</div>
</div>
@elseif(config('LaravelLogger.loggerPaginationEnabled'))
<div class="text-center">
<div class="d-flex justify-content-center">
{!! $activities->links('vendor.pagination.bootstrap-4') !!}
Expand Down