Allow Debugbar to work with runtime connection (#1526)

* Allow Debugbar to work with runtime connection

* rename test

* different testing strategy for Laravel 9 and Laravel 10

* review

Author: deleugpn

src/LaravelDebugbar.php

@@ -288,8 +288,10 @@ function (\Illuminate\Log\Events\MessageLogged $log) use ($logger) {
             }
         }
 
-        if ($this->shouldCollect('db', true) && isset($this->app['db'])) {
-            $db = $this->app['db'];
+        if ($this->shouldCollect('db', true) && isset($this->app['db']) && isset($this->app['events'])) {
+            /** @var \Illuminate\Events\Dispatcher $events */
+            $events = $this->app['events'];
+
             if (
                 $debugbar->hasCollector('time') && $this->app['config']->get(
                     'debugbar.options.db.timeline',
@@ -336,7 +338,7 @@ function (\Illuminate\Log\Events\MessageLogged $log) use ($logger) {
             $this->addCollector($queryCollector);
 
             try {
-                $db->listen(
+                $events->listen(
                     function (\Illuminate\Database\Events\QueryExecuted $query) {
                         if (!app(static::class)->shouldCollect('db', true)) {
                             return; // Issue 776 : We've turned off collecting after the listener was attached
@@ -354,49 +356,49 @@ function (\Illuminate\Database\Events\QueryExecuted $query) {
             }
 
             try {
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     \Illuminate\Database\Events\TransactionBeginning::class,
                     function ($transaction) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Begin Transaction', $transaction->connection);
                     }
                 );
 
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     \Illuminate\Database\Events\TransactionCommitted::class,
                     function ($transaction) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Commit Transaction', $transaction->connection);
                     }
                 );
 
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     \Illuminate\Database\Events\TransactionRolledBack::class,
                     function ($transaction) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Rollback Transaction', $transaction->connection);
                     }
                 );
 
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     'connection.*.beganTransaction',
                     function ($event, $params) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Begin Transaction', $params[0]);
                     }
                 );
 
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     'connection.*.committed',
                     function ($event, $params) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Commit Transaction', $params[0]);
                     }
                 );
 
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     'connection.*.rollingBack',
                     function ($event, $params) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Rollback Transaction', $params[0]);
                     }
                 );
 
-                $db->getEventDispatcher()->listen(
+                $events->listen(
                     function (\Illuminate\Database\Events\ConnectionEstablished $event) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Connection Established', $event->connection);
 

tests/DataCollector/QueryCollectorRuntimeDatabaseTest.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Barryvdh\Debugbar\Tests\DataCollector;
+
+use Barryvdh\Debugbar\Tests\TestCase;
+use Illuminate\Database\Connection;
+use Illuminate\Database\Events\QueryExecuted;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Arr;
+
+class QueryCollectorRuntimeDatabaseTest extends TestCase
+{
+    protected function getEnvironmentSetUp($app)
+    {
+        $app['config']->set('database.default', null);
+
+        $app['config']->set('database.connections', []);
+    }
+
+    public function testCollectsQueriesFromRuntimeConnections()
+    {
+        if (version_compare($this->app->version(), '10', '<')) {
+            $this->markTestSkipped('This test is not compatible with Laravel 9.x and below');
+        }
+
+        debugbar()->boot();
+
+        /** @var Connection $connection */
+        $connection = $this->app['db']->connectUsing(
+            'runtime-connection',
+            [
+                'driver' => 'sqlite',
+                'database' => ':memory:',
+            ],
+        );
+
+        $connection->statement('SELECT 1');
+
+        /** @var \Debugbar\DataCollector\ExceptionsCollector $collector */
+        $exceptions = debugbar()->getCollector('exceptions');
+
+        self::assertEmpty($exceptions->getExceptions());
+
+        /** @var \Barryvdh\Debugbar\DataCollector\QueryCollector $collector */
+        $collector  = debugbar()->getCollector('queries');
+
+        tap($collector->collect(), function (array $collection) {
+            $this->assertEquals(1, $collection['nb_statements']);
+
+            self::assertSame('SELECT 1', $collection['statements'][2]['sql']);
+        });
+    }
+
+    public function testCollectsQueriesFromRuntimeConnectionsWithoutConnectUsing()
+    {
+        debugbar()->boot();
+
+        $this->app['config']->set('database.connections.dynamic-connection', [
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+        ]);
+
+        $this->app['config']->set('database.default', 'dynamic-connection');
+
+        /** @var Connection $connection */
+        $connection = $this->app['db']->connection('dynamic-connection');
+
+        $connection->statement('SELECT 1');
+
+        /** @var \Debugbar\DataCollector\ExceptionsCollector $collector */
+        $exceptions = debugbar()->getCollector('exceptions');
+
+        self::assertEmpty($exceptions->getExceptions());
+
+        /** @var \Barryvdh\Debugbar\DataCollector\QueryCollector $collector */
+        $collector  = debugbar()->getCollector('queries');
+
+        tap($collector->collect(), function (array $collection) {
+            $this->assertEquals(1, $collection['nb_statements']);
+
+            self::assertSame('SELECT 1', $collection['statements'][2]['sql']);
+        });
+    }
+}