Merge branch 'master' of github.com:beyondcode/laravel-query-detector

Author: mpociot

.gitignore

@@ -3,4 +3,5 @@ composer.lock
 docs
 vendor
 coverage
-.idea
+.idea
+nbproject

README.md

@@ -7,7 +7,7 @@
 
 The Laravel N+1 query detector helps you to increase your application's performance by reducing the number of queries it executes. This package monitors your queries in real-time, while you develop your application and notify you when you should add eager loading (N+1 queries).
 
-![Example alert](https://beyondco.de/github/n+1/alert.png) 
+![Example alert](https://beyondco.de/github/n+1/alert.png)
 
 ## Installation
 
@@ -42,7 +42,7 @@ return [
      * If this is set to "null", the app.debug config value will be used.
      */
     'enabled' => env('QUERY_DETECTOR_ENABLED', null),
-    
+
     /*
      * Threshold level for the N+1 query detection. If a relation query will be
      * executed more then this amount, the detector will notify you about it.
@@ -64,7 +64,7 @@ return [
     ],
 
     /*
-     * Define the output format that you want to use.
+     * Define the output format that you want to use. Multiple classes are supported
      * Available options are:
      *
      * Alert:
@@ -75,11 +75,19 @@ return [
      * Writes the N+1 queries into the Laravel.log file
      * \BeyondCode\QueryDetector\Outputs\Log::class
      */
-    'output' => \BeyondCode\QueryDetector\Outputs\Alert::class,
+    'output' => [
+        \BeyondCode\QueryDetector\Outputs\Alert::class
+    ]
 
 ];
 ```
 
+If you use **Lumen**, you need to copy the config file manually and register the Lumen Service Provider in `bootstrap/app.php` file
+
+```php
+$this->app->register(\BeyondCode\QueryDetector\LumenQueryDetectorServiceProvider::class);
+```
+
 ### Testing
 
 ``` bash

config/config.php

@@ -22,17 +22,23 @@
     ],
 
     /*
-     * Define the output format that you want to use.
+     * Define the output formats that you want to use.
      * Available options are:
      *
      * Alert:
      * Displays an alert on the website
      * \BeyondCode\QueryDetector\Outputs\Alert::class
      *
+     * Debugbar: (make sure you have the barryvdh/laravel-debugbar package installed)
+     * Writes the N+1 queries into a custom messages collector of Debugbar
+     * \BeyondCode\QueryDetector\Outputs\Debugbar::class
+     *
      * Log:
      * Writes the N+1 queries into the Laravel.log file
      * \BeyondCode\QueryDetector\Outputs\Log::class
      */
-    'output' => \BeyondCode\QueryDetector\Outputs\Alert::class,
-
-];
+    'output' => [
+        \BeyondCode\QueryDetector\Outputs\Log::class,
+        \BeyondCode\QueryDetector\Outputs\Alert::class,
+    ]
+];

src/LumenQueryDetectorServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+namespace BeyondCode\QueryDetector;
+
+use Illuminate\Support\ServiceProvider;
+
+class LumenQueryDetectorServiceProvider extends ServiceProvider
+{
+
+    public function register()
+    {
+        $this->app->configure('querydetector');
+        $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'querydetector');
+
+        $this->app->middleware([
+            QueryDetectorMiddleware::class
+        ]);
+
+        $this->app->singleton(QueryDetector::class);
+        $this->app->alias(QueryDetector::class, 'querydetector');
+    }
+}

src/Outputs/Console.php

@@ -0,0 +1,38 @@
+<?php
+namespace BeyondCode\QueryDetector\Outputs;
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+class Console implements Output
+{
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        if ($response->isRedirection()) {
+            return;
+        }
+        $content = $response->getContent();
+        $outputContent = $this->getOutputContent($detectedQueries);
+        $pos = strripos($content, '</body>');
+        if (false !== $pos) {
+            $content = substr($content, 0, $pos) . $outputContent . substr($content, $pos);
+        } else {
+            $content = $content . $outputContent;
+        }
+        // Update the new content and reset the content length
+        $response->setContent($content);
+        $response->headers->remove('Content-Length');
+    }
+    protected function getOutputContent(Collection $detectedQueries)
+    {
+        $output = '<script type="text/javascript">';
+        $output .= "console.warn('Found the following N+1 queries in this request:\\n\\n";
+        foreach ($detectedQueries as $detectedQuery) {
+            $output .= "Model: ".addslashes($detectedQuery['model']). " => Relation: ".addslashes($detectedQuery['relation']);
+            $output .= " - You should add \"with(\'".$detectedQuery['relation']."\')\" to eager-load this relation.";
+            $output .= "\\n";
+        }
+        $output .= "')";
+        $output .= '</script>';
+        return $output;
+    }
+}

src/Outputs/Debugbar.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+use Debugbar as LaravelDebugbar;
+use DebugBar\DataCollector\MessagesCollector;
+
+class Debugbar implements Output
+{
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        $collector = new MessagesCollector('N+1 Queries');
+
+        foreach ($detectedQueries as $detectedQuery) {
+            $collector->addMessage(sprintf('Model: %s => Relation: %s - You should add with(%s) to eager-load this relation.',
+                $detectedQuery['model'],
+                $detectedQuery['relation'],
+                $detectedQuery['relation']
+            ));
+        }
+
+        LaravelDebugbar::addCollector($collector);
+    }
+}

src/QueryDetector.php

@@ -172,8 +172,15 @@ public function getDetectedQueries(): Collection
 
     protected function applyOutput(Response $response)
     {
-        $outputType = app(config('querydetector.output'));
-        $outputType->output($this->getDetectedQueries(), $response);
+        $outputTypes = app(config('querydetector.output'));
+
+        if (! is_array($outputTypes)) {
+            $types = [$outputTypes];
+        }
+
+        foreach ($outputTypes as $type) {
+            $type->output($this->getDetectedQueries(), $response);
+        }
     }
 
     public function output($request, $response)