Added QueryLogger Helper

gema · Jul 20, 2023 · 5f4c94f · 5f4c94f
1 parent f615ffd
commit 5f4c94f
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 4 deletions.
diff --git a/src/FrameworkServiceProvider.php b/src/FrameworkServiceProvider.php
@@ -2,6 +2,9 @@
 
 namespace GemaDigital\Framework;
 
+use DB;
+use GemaDigital\Framework\app\Helpers\QueryLogger;
+use Illuminate\Database\Events\QueryExecuted;
 use Illuminate\Support\ServiceProvider;
 
 class FrameworkServiceProvider extends ServiceProvider
@@ -31,6 +34,11 @@ public function boot()
             $this->bootForConsole();
         }
 
+        // Log all queries
+        if (config('app.debug')) {
+            DB::listen(fn(QueryExecuted $log) => QueryLogger::log($log));
+        }
+
         // Blade directives
 
         // SVG

diff --git a/src/app/Helpers/CommonHelper.php b/src/app/Helpers/CommonHelper.php
@@ -1,10 +1,12 @@
 <?php
 
 use App\Models\User;
+use GemaDigital\Framework\app\Helpers\QueryLogger;
 use Illuminate\Http\Response;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Config;
-use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
 
 if (! function_exists('user')) {
@@ -175,6 +177,8 @@ function json_response(mixed $data = null, int $code = 0, int $status = 200, mix
                 )
             );
 
+            $queries = QueryLogger::list();
+
             $response = array_merge($response, ['debug' => [
                 'time' => [
                     'value' => $timeData[0],
@@ -185,7 +189,11 @@ function json_response(mixed $data = null, int $code = 0, int $status = 200, mix
                     'unit' => $memoryData[1],
                 ],
                 'exception' => $exception,
-                'queries' => DB::getQueryLog(),
+                'query' => [
+                    'count' => count($queries),
+                    'time' => collect($queries)->pluck('time')->sum(),
+                    'list' => $queries,
+                ],
                 'post' => request()->request->all(),
             ]]);
         }
@@ -230,6 +238,25 @@ function json_status(bool $status, int $success = 200, int $fail = 400): Respons
     }
 }
 
+if (! function_exists('json_response_pagination')) {
+    function json_response_pagination(mixed $data = null, LengthAwarePaginator $pagination, int $code = 0, int $status = 200, mixed $errors = null, $exception = null): Response
+    {
+        $data = [
+            ...$data,
+            'pagination' => Arr::only($pagination->toArray(), [
+                'from',
+                'to',
+                'total',
+                'per_page',
+                'last_page',
+                'current_page',
+            ]),
+        ];
+
+        return json_response($data, $code, $status, $errors, $exception);
+    }
+}
+
 if (! function_exists('sized_image')) {
     function sized_image(string $path, int $size): string
     {
@@ -277,8 +304,7 @@ function __call($method, $params)
 
                 $signature = $method.crc32(json_encode($params));
 
-                return $this->memo[$this->target][$signature]
-                ??=$this->target->$method(...$params);
+                return $this->memo[$this->target][$signature] ??= $this->target->$method(...$params);
             }
         };
     }

diff --git a/src/app/Helpers/QueryLogger.php b/src/app/Helpers/QueryLogger.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace GemaDigital\Framework\app\Helpers;
+
+use Illuminate\Database\Events\QueryExecuted;
+
+class QueryLogger
+{
+    private static $queryLogs = [];
+
+    /**
+     * Logs a query
+     *
+     * @param QueryExecuted $log
+     * @return void
+     */
+    public static function log(QueryExecuted $log): void
+    {
+        array_push(self::$queryLogs, [
+            'sql' => vsprintf(str_replace(['%', '?'], ['%%', '%s'], $log->sql), $log->bindings),
+            'time' => $log->time,
+        ]);
+    }
+
+    /**
+     * Get query Log
+     *
+     * @return array
+     */
+    public static function list(): array
+    {
+        return self::$queryLogs;
+    }
+}