Merge pull request #4 from ilzrv/lib_revision

Revision of the entire library

Author: ilzrv

.github/workflows/tests.yml

@@ -9,40 +9,8 @@ jobs:
 
     strategy:
       matrix:
-        php: [7.1, 7.2, 7.3, 7.4, 8.0]
-        laravel: [5.6.*, 5.7.*, 5.8.*, 6.*, 7.*, 8.*]
-        include:
-          - laravel: 5.6.*
-            testbench: 3.6.*
-          - laravel: 5.7.*
-            testbench: 3.7.*
-          - laravel: 5.8.*
-            testbench: 3.8.*
-          - laravel: 6.*
-            testbench: 4.*
-          - laravel: 7.*
-            testbench: 5.*
-          - laravel: 8.*
-            testbench: 6.*
-        exclude:
-          - laravel: 5.6.*
-            php: 8.0
-          - laravel: 5.7.*
-            php: 8.0
-          - laravel: 5.8.*
-            php: 8.0
-          - laravel: 6.*
-            php: 7.1
-          - laravel: 7.*
-            php: 7.1
-          - laravel: 8.*
-            php: 7.1
-          - laravel: 6.*
-            php: 7.2
-          - laravel: 7.*
-            php: 7.2
-          - laravel: 8.*
-            php: 7.2
+        php: [8.0, 8.1]
+        laravel: [9.*]
 
     steps:
       - name: Checkout Code
@@ -55,7 +23,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+          composer require "laravel/framework:${{ matrix.laravel }}" orchestra/testbench --no-interaction --no-update
           composer update --prefer-dist --no-interaction --no-progress --no-suggest
 
       - name: Execute tests

README.md

@@ -8,7 +8,8 @@ This package allows you to detect controller methods in the code that make a lot
 
 ## Requirements
 
- * Laravel 5.6+
+ * PHP 8.0 / 8.1
+ * Laravel 9
 
 ## Installation
 

composer.json

@@ -2,7 +2,8 @@
     "name": "ilzrv/laravel-slow-query-detector",
     "description": "Laravel Slow DB Query Detector",
     "require": {
-        "illuminate/support": "^5.6|^6.0|^7.0|^8.0"
+        "php": "^8.0",
+        "illuminate/support": "^9.0"
     },
     "license": "MIT",
     "authors": [
@@ -29,8 +30,8 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.0 || ^8.0 || ^9.0",
-        "orchestra/testbench": "^3.0 || ^4.0 || ^5.0 || ^6.0",
-        "timacdonald/log-fake": "^1.6"
+        "phpunit/phpunit": "^9.5",
+        "orchestra/testbench": "^7.0",
+        "timacdonald/log-fake": "^2.0"
     }
 }

src/Http/Middleware/SlowQueryDetectorMiddleware.php

@@ -1,31 +1,41 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ilzrv\LaravelSlowQueryDetector\Http\Middleware;
 
 use Closure;
-use Illuminate\Support\Facades\Log;
+use Illuminate\Database\Connection;
+use Illuminate\Database\Events\QueryExecuted;
+use Illuminate\Http\Request;
 use Illuminate\Support\Str;
+use Psr\Log\LoggerInterface;
 
-class SlowQueryDetectorMiddleware
+final class SlowQueryDetectorMiddleware
 {
-    protected $queriesCount = 0;
-    protected $heavyQueryCount = 0;
-    protected $heaviestQueryTime = 0;
-    protected $heaviestQuery = '';
-    protected $executionTime = 0;
-
-    /**
-     * Handle an incoming request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
-     */
-    public function handle($request, Closure $next)
-    {
+    protected int $queriesCount = 0;
+
+    protected int $heavyQueryCount = 0;
+
+    protected float $heaviestQueryTime = 0;
+
+    protected string $heaviestQuery = '';
+
+    protected float $executionTime = 0;
+
+    public function __construct(
+        private Connection $dbConnection,
+        private LoggerInterface $logger,
+    ) {
+    }
+
+    public function handle(
+        Request $request,
+        Closure $next,
+    ): mixed {
         $this->executionTime = -round(microtime(true) * 1000);
 
-        \DB::listen(function ($query) {
+        $this->dbConnection->listen(function (QueryExecuted $query) {
             $this->queriesCount++;
             if ($query->time > config('sqd.query.max_time')) {
                 $this->heavyQueryCount++;
@@ -47,14 +57,14 @@ public function handle($request, Closure $next)
         return $next;
     }
 
-    protected function needNotify()
+    protected function needNotify(): bool
     {
         return $this->queriesCount > config('sqd.code.max_queries')
             || $this->executionTime > config('sqd.code.max_time')
             || $this->heaviestQueryTime > config('sqd.query.max_time');
     }
 
-    protected function notify($request)
+    protected function notify(Request $request): void
     {
         $data = [
             'SQD' => [
@@ -66,14 +76,16 @@ protected function notify($request)
                 'Heaviest Query' => [
                     'Query' => $this->heaviestQuery,
                     'Time' => $this->heaviestQueryTime . ' ms.',
-                ]
-            ]
+                ],
+            ],
         ];
 
-        Log::critical(print_r($data, true));
+        $this->logger->critical(
+            print_r($data, true)
+        );
     }
 
-    protected function getQuery($query)
+    protected function getQuery(QueryExecuted $query): string
     {
         return config('sqd.query.with_bindings')
             ? Str::replaceArray('?', $query->bindings, $query->sql)

src/ServiceProvider.php

@@ -1,31 +1,23 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ilzrv\LaravelSlowQueryDetector;
 
 use Ilzrv\LaravelSlowQueryDetector\Http\Middleware\SlowQueryDetectorMiddleware;
 
-class ServiceProvider extends \Illuminate\Support\ServiceProvider
+final class ServiceProvider extends \Illuminate\Support\ServiceProvider
 {
-    /**
-     * Register services.
-     *
-     * @return void
-     */
-    public function register()
+    public function register(): void
     {
         $this->mergeConfigFrom(__DIR__ . '/../config/sqd.php', 'sqd');
     }
 
-    /**
-     * Bootstrap services.
-     *
-     * @return void
-     */
-    public function boot()
+    public function boot(): void
     {
         $this->publishes([__DIR__ . '/../config/sqd.php' => config_path('sqd.php')]);
 
-        if (config('sqd.enabled')) {
+        if (config('sqd.enabled') === true) {
             $this->app['router']->pushMiddlewareToGroup('web', SlowQueryDetectorMiddleware::class);
         }
     }

tests/SlowCodeTest.php

@@ -4,30 +4,27 @@
 
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
+use TiMacDonald\Log\LogEntry;
 
 class SlowCodeTest extends TestCase
 {
-    public function testBeNotifiedWhenCodeExceededMaxTime()
+    public function testBeNotifiedWhenCodeExceededMaxTime(): void
     {
-        $this->request(function () {
-            usleep(1000001); // 1 s
-        });
+        $this->request(fn() => usleep(1000000)); // 1 s
 
-        Log::assertLogged('critical', function ($message, $context) {
-            return Str::contains($message, 'SQD');
-        });
+        Log::assertLogged(
+            fn(LogEntry $log) => $log->level === 'critical' && Str::contains($log->message, 'SQD')
+        );
     }
 
-    public function testBeSilentWhenCodeRunsFine()
+    public function testBeSilentWhenCodeRunsFine(): void
     {
-        $this->request(function () {
-            usleep(900000); // 0.9 s
-        });
+        $this->request(fn() => usleep(900000)); // 0.9 s
 
-        Log::assertNotLogged('critical');
+        Log::assertNotLogged(fn(LogEntry $log) => $log->level === 'critical');
     }
 
-    public function testBeNotifiedWhenCodeHasTooManyQueries()
+    public function testBeNotifiedWhenCodeHasTooManyQueries(): void
     {
         $this->request(function () {
             $connection = $this->getConnectionWithSleepFunction();
@@ -36,12 +33,12 @@ public function testBeNotifiedWhenCodeHasTooManyQueries()
             }
         });
 
-        Log::assertLogged('critical', function ($message, $context) {
-            return Str::contains($message, 'SQD');
-        });
+        Log::assertLogged(
+            fn(LogEntry $log) => $log->level === 'critical' && Str::contains($log->message, 'SQD')
+        );
     }
 
-    public function testBeSilentWhenCodeHasFineCountQueries()
+    public function testBeSilentWhenCodeHasFineCountQueries(): void
     {
         $this->request(function () {
             $connection = $this->getConnectionWithSleepFunction();
@@ -50,6 +47,6 @@ public function testBeSilentWhenCodeHasFineCountQueries()
             }
         });
 
-        Log::assertNotLogged('critical');
+        Log::assertNotLogged(fn(LogEntry $log) => $log->level === 'critical');
     }
 }

tests/SlowQueryTest.php

@@ -1,13 +1,16 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ilzrv\LaravelSlowQueryDetector\Tests;
 
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
+use TiMacDonald\Log\LogEntry;
 
-class SlowQueryTest extends TestCase
+final class SlowQueryTest extends TestCase
 {
-    public function testBeNotifiedWhenQueryExceededMaxTime()
+    public function testBeNotifiedWhenQueryExceededMaxTime(): void
     {
         $this->request(function () {
             $connection = $this->getConnectionWithSleepFunction();
@@ -16,12 +19,12 @@ public function testBeNotifiedWhenQueryExceededMaxTime()
             return response('slow');
         });
 
-        Log::assertLogged('critical', function ($message, $context) {
-            return Str::contains($message, 'SQD');
-        });
+        Log::assertLogged(
+            fn(LogEntry $log) => $log->level === 'critical' && Str::contains($log->message, 'SQD')
+        );
     }
 
-    public function testBeSilentWhenQueryNotExceededMaxTime()
+    public function testBeSilentWhenQueryNotExceededMaxTime(): void
     {
         $this->request(function () {
             $connection = $this->getConnectionWithSleepFunction();
@@ -30,6 +33,6 @@ public function testBeSilentWhenQueryNotExceededMaxTime()
             return response('fast');
         });
 
-        Log::assertNotLogged('critical');
+        Log::assertNotLogged(fn(LogEntry $log) => $log->level === 'critical');
     }
 }