Prevent unnecessary query logging on exceptions with a custom renderer (#56874)

Author: luanfreitasdev

src/Illuminate/Foundation/Providers/FoundationServiceProvider.php

@@ -8,6 +8,7 @@
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Contracts\Foundation\ExceptionRenderer;
 use Illuminate\Contracts\Foundation\MaintenanceMode as MaintenanceModeContract;
 use Illuminate\Contracts\View\Factory;
 use Illuminate\Database\ConnectionInterface;
@@ -70,7 +71,7 @@ public function boot()
             ], 'laravel-errors');
         }
 
-        if ($this->app->hasDebugModeEnabled()) {
+        if ($this->app->hasDebugModeEnabled() && ! $this->app->has(ExceptionRenderer::class)) {
             $this->app->make(Listener::class)->registerListeners(
                 $this->app->make(Dispatcher::class)
             );

tests/Integration/Foundation/Exceptions/RendererTest.php

@@ -2,7 +2,12 @@
 
 namespace Illuminate\Tests\Integration\Foundation\Exceptions;
 
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Contracts\Foundation\ExceptionRenderer;
+use Illuminate\Foundation\Exceptions\Renderer\Listener;
 use Illuminate\Foundation\Exceptions\Renderer\Renderer;
+use Illuminate\Foundation\Providers\FoundationServiceProvider;
+use Mockery;
 use Orchestra\Testbench\Attributes\WithConfig;
 use Orchestra\Testbench\TestCase;
 use RuntimeException;
@@ -37,4 +42,101 @@ public function testItCanRenderExceptionPageUsingSymfonyIfRendererIsNotDefined()
             ->assertSee('RuntimeException')
             ->assertSee('Bad route!');
     }
+
+    #[WithConfig('app.debug', true)]
+    public function testItCanRenderExceptionPageWithRendererWhenDebugEnabled()
+    {
+        $this->app->singleton(ExceptionRenderer::class, function () {
+            return new class() implements ExceptionRenderer
+            {
+                public function render($throwable)
+                {
+                    return response('Custom Exception Renderer: '.$throwable->getMessage(), 500);
+                }
+            };
+        });
+
+        $this->assertTrue($this->app->bound(ExceptionRenderer::class));
+
+        $this->get('/failed')
+            ->assertInternalServerError()
+            ->assertSee('Custom Exception Renderer: Bad route!');
+    }
+
+    #[WithConfig('app.debug', false)]
+    public function testItDoesNotRenderExceptionPageWithRendererWhenDebugDisabled()
+    {
+        $this->app->singleton(ExceptionRenderer::class, function () {
+            return new class() implements ExceptionRenderer
+            {
+                public function render($throwable)
+                {
+                    return response('Custom Exception Renderer: '.$throwable->getMessage(), 500);
+                }
+            };
+        });
+
+        $this->assertTrue($this->app->bound(ExceptionRenderer::class));
+
+        $this->get('/failed')
+            ->assertInternalServerError()
+            ->assertDontSee('Custom Exception Renderer: Bad route!');
+    }
+
+    #[WithConfig('app.debug', false)]
+    public function testItDoesNotRegisterListenersWhenDebugDisabled()
+    {
+        $this->app->forgetInstance(ExceptionRenderer::class);
+        $this->assertFalse($this->app->bound(ExceptionRenderer::class));
+
+        $listener = Mockery::mock(Listener::class);
+        $listener->shouldReceive('registerListeners')->never();
+
+        $this->app->instance(Listener::class, $listener);
+        $this->app->instance(Dispatcher::class, Mockery::mock(Dispatcher::class));
+
+        $provider = $this->app->getProvider(FoundationServiceProvider::class);
+        $provider->boot();
+    }
+
+    #[WithConfig('app.debug', true)]
+    public function testItDoesNotRegisterListenersWhenRendererBound()
+    {
+        $this->app->singleton(ExceptionRenderer::class, function () {
+            return new class() implements ExceptionRenderer
+            {
+                public function render($throwable)
+                {
+                    return response('Custom Exception Renderer: '.$throwable->getMessage(), 500);
+                }
+            };
+        });
+
+        $this->assertTrue($this->app->bound(ExceptionRenderer::class));
+
+        $listener = Mockery::mock(Listener::class);
+        $listener->shouldReceive('registerListeners')->never();
+
+        $this->app->instance(Listener::class, $listener);
+        $this->app->instance(Dispatcher::class, Mockery::mock(Dispatcher::class));
+
+        $provider = $this->app->getProvider(FoundationServiceProvider::class);
+        $provider->boot();
+    }
+
+    #[WithConfig('app.debug', true)]
+    public function testItRegistersListenersWhenRendererNotBound()
+    {
+        $this->app->forgetInstance(ExceptionRenderer::class);
+        $this->assertFalse($this->app->bound(ExceptionRenderer::class));
+
+        $listener = Mockery::mock(Listener::class);
+        $listener->shouldReceive('registerListeners')->once();
+
+        $this->app->instance(Listener::class, $listener);
+        $this->app->instance(Dispatcher::class, Mockery::mock(Dispatcher::class));
+
+        $provider = $this->app->getProvider(FoundationServiceProvider::class);
+        $provider->boot();
+    }
 }