Fix issues with Debugbar output when used with SPAs/ajax requests

Debugbar's UI only shows tabs for MessageCollectors added during the initial page load. Previously, the N+1 Queries MessageCollector was only added to Debugbar when N+1 queries were actually detected. This meant that if no queries were detected on the initial page load, but they were detected during subsequent requests made via JS, those queries wouldn't show up because the tab wouldn't appear within Debugbar.

Author: misenhower

src/Outputs/Alert.php

@@ -7,6 +7,11 @@
 
 class Alert implements Output
 {
+    public function boot()
+    {
+        //
+    }
+
     public function output(Collection $detectedQueries, Response $response)
     {
         if (stripos($response->headers->get('Content-Type'), 'text/html') !== 0 || $response->isRedirection()) {

src/Outputs/Console.php

@@ -7,6 +7,11 @@
 
 class Console implements Output
 {
+    public function boot()
+    {
+        //
+    }
+
     public function output(Collection $detectedQueries, Response $response)
     {
         if (stripos($response->headers->get('Content-Type'), 'text/html') !== 0 || $response->isRedirection()) {

src/Outputs/Debugbar.php

@@ -10,18 +10,23 @@
 
 class Debugbar implements Output
 {
-    public function output(Collection $detectedQueries, Response $response)
+    protected $collector;
+
+    public function boot()
     {
-        $collector = new MessagesCollector('N+1 Queries');
+        $this->collector = new MessagesCollector('N+1 Queries');
+
+        LaravelDebugbar::addCollector($this->collector);
+    }
 
+    public function output(Collection $detectedQueries, Response $response)
+    {
         foreach ($detectedQueries as $detectedQuery) {
-            $collector->addMessage(sprintf('Model: %s => Relation: %s - You should add `with(%s)` to eager-load this relation.',
+            $this->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/Outputs/Json.php

@@ -7,6 +7,10 @@
 
 class Json implements Output
 {
+    public function boot()
+    {
+        //
+    }
 
     public function output(Collection $detectedQueries, Response $response)
     {

src/Outputs/Log.php

@@ -8,6 +8,11 @@
 
 class Log implements Output
 {
+    public function boot()
+    {
+        //
+    }
+
     public function output(Collection $detectedQueries, Response $response)
     {
         LaravelLog::info('Detected N+1 Query');
@@ -23,4 +28,4 @@ public function output(Collection $detectedQueries, Response $response)
             }
         }
     }
-}
+}

src/Outputs/Output.php

@@ -7,5 +7,7 @@
 
 interface Output
 {
+    public function boot();
+
     public function output(Collection $detectedQueries, Response $response);
-}
+}

src/QueryDetector.php

@@ -26,6 +26,11 @@ public function boot()
 
             $this->logQuery($query, $backtrace);
         });
+
+        foreach ($this->getOutputTypes() as $outputType) {
+            app()->singleton($outputType);
+            app($outputType)->boot();
+        }
     }
 
     public function isEnabled(): bool
@@ -179,15 +184,20 @@ public function getDetectedQueries(): Collection
         return $queries;
     }
 
-    protected function applyOutput(Response $response)
+    protected function getOutputTypes()
     {
         $outputTypes = config('querydetector.output');
 
         if (! is_array($outputTypes)) {
             $outputTypes = [$outputTypes];
         }
 
-        foreach ($outputTypes as $type) {
+        return $outputTypes;
+    }
+
+    protected function applyOutput(Response $response)
+    {
+        foreach ($this->getOutputTypes() as $type) {
             app($type)->output($this->getDetectedQueries(), $response);
         }
     }