[12.x] Improve BroadcastManager error messages when trying to get a Broadcaster (#57275)

* [12.x] Improve BroadcastManager error messages when trying to get a Broadcaster

Previously, when a broadcaster driver failed to initialize, the error message would only show the underlying exception without indicating which broadcasting connection configuration was responsible, and it was hard to identify it was actually coming from a broadcaster.

Missing to provide a value for REVERB_APP_KEY, REVERB_APP_ID or REVERB_APP_SECRET would throw an error such as `TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given` and it would occur after running `composer install`, `php artisan optimize` or any command that would cause the broadcasting to be booted.

This change wraps driver creation in a try-catch block that throws a BroadcastException with the connection name, making it immediately clear where the error is coming from and which configuration needs to be fixed.

Before:
  > TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

After:
  > BroadcastException: Failed to create broadcaster for connection "terminal" with error: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

* [12.x] Improve BroadcastManager error messages when trying to get a Broadcaster

Previously, when a broadcaster driver failed to initialize, the error message would only show the underlying exception without indicating which broadcasting connection configuration was responsible, and it was hard to identify it was actually coming from a broadcaster.

Missing to provide a value for REVERB_APP_KEY, REVERB_APP_ID or REVERB_APP_SECRET would throw an error such as `TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given` and it would occur after running `composer install`, `php artisan optimize` or any command that would cause the broadcasting to be booted.

This change wraps driver creation in a try-catch block that throws a BroadcastException with the connection name, making it immediately clear where the error is coming from and which configuration needs to be fixed.

Before:
  > TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

After:
  > BroadcastException: Failed to create broadcaster for connection "my-connection" with error: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

* [12.x] Improve BroadcastManager error messages when trying to get a Broadcaster

Previously, when a broadcaster driver failed to initialize, the error message would only show the underlying exception without indicating which broadcasting connection configuration was responsible, and it was hard to identify it was actually coming from a broadcaster.

Missing to provide a value for REVERB_APP_KEY, REVERB_APP_ID or REVERB_APP_SECRET would throw an error such as `TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given` and it would occur after running `composer install`, `php artisan optimize` or any command that would cause the broadcasting to be booted.

This change wraps driver creation in a try-catch block that throws a BroadcastException with the connection name, making it immediately clear where the error is coming from and which configuration needs to be fixed.

Before:
  > TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

After:
  > BroadcastException: Failed to create broadcaster for connection "my-connection" with error: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

* [12.x] Improve BroadcastManager error messages when trying to get a Broadcaster

Previously, when a broadcaster driver failed to initialize, the error message would only show the underlying exception without indicating which broadcasting connection configuration was responsible, and it was hard to identify it was actually coming from a broadcaster.

Missing to provide a value for REVERB_APP_KEY, REVERB_APP_ID or REVERB_APP_SECRET would throw an error such as `TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given` and it would occur after running `composer install`, `php artisan optimize` or any command that would cause the broadcasting to be booted.

This change wraps driver creation in a try-catch block that throws a BroadcastException with the connection name, making it immediately clear where the error is coming from and which configuration needs to be fixed.

Before:
  > TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

After:
  > BroadcastException: Failed to create broadcaster for connection "my-connection" with error: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

* [12.x] Improve BroadcastManager error messages when trying to get a Broadcaster

Previously, when a broadcaster driver failed to initialize, the error message would only show the underlying exception without indicating which broadcasting connection configuration was responsible, and it was hard to identify it was actually coming from a broadcaster.

Missing to provide a value for REVERB_APP_KEY, REVERB_APP_ID or REVERB_APP_SECRET would throw an error such as `TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given` and it would occur after running `composer install`, `php artisan optimize` or any command that would cause the broadcasting to be booted.

This change wraps driver creation in a try-catch block that throws a BroadcastException with the connection name, making it immediately clear where the error is coming from and which configuration needs to be fixed.

Before:
  > TypeError: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

After:
  > BroadcastException: Failed to create broadcaster for connection "my-connection" with error: Pusher\Pusher::__construct(): Argument #3 ($app_id) must be of type string, null given

Testing using the LogBroadcaster since it is always available, while Pusher\Pusher is not.

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: mathiasgrimm

src/Illuminate/Broadcasting/BroadcastManager.php

@@ -21,6 +21,8 @@
 use InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Pusher\Pusher;
+use RuntimeException;
+use Throwable;
 
 /**
  * @mixin \Illuminate\Contracts\Broadcasting\Broadcaster
@@ -292,7 +294,11 @@ protected function resolve($name)
             throw new InvalidArgumentException("Driver [{$config['driver']}] is not supported.");
         }
 
-        return $this->{$driverMethod}($config);
+        try {
+            return $this->{$driverMethod}($config);
+        } catch (Throwable $e) {
+            throw new RuntimeException("Failed to create broadcaster for connection \"{$name}\" with error: {$e->getMessage()}.", 0, $e);
+        }
     }
 
     /**

tests/Integration/Broadcasting/BroadcastManagerTest.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Tests\Integration\Broadcasting;
 
 use Illuminate\Broadcasting\BroadcastEvent;
+use Illuminate\Broadcasting\BroadcastException;
 use Illuminate\Broadcasting\BroadcastManager;
 use Illuminate\Broadcasting\UniqueBroadcastEvent;
 use Illuminate\Config\Repository;
@@ -17,6 +18,7 @@
 use Illuminate\Support\Facades\Queue;
 use InvalidArgumentException;
 use Orchestra\Testbench\TestCase;
+use RuntimeException;
 
 class BroadcastManagerTest extends TestCase
 {
@@ -100,6 +102,35 @@ public function testThrowExceptionWhenUnknownStoreIsUsed()
         $broadcastManager->connection('alien_connection');
     }
 
+    public function testThrowExceptionWhenDriverCreationFails()
+    {
+        $userConfig = [
+            'broadcasting' => [
+                'connections' => [
+                    'log_connection_1' => [
+                        'driver' => 'log',
+                    ],
+                ],
+            ],
+        ];
+
+        $app = $this->getApp($userConfig);
+        $app->singleton(\Psr\Log\LoggerInterface::class, function () {
+            throw new \RuntimeException('Logger service not available');
+        });
+
+        $broadcastManager = new BroadcastManager($app);
+
+        try {
+            $broadcastManager->connection('log_connection_1');
+            $this->fail('Expected BroadcastException was not thrown');
+        } catch (RuntimeException $e) {
+            $this->assertStringContainsString('Failed to create broadcaster for connection "log_connection_1"', $e->getMessage());
+            $this->assertStringContainsString('Logger service not available', $e->getMessage());
+            $this->assertInstanceOf(\RuntimeException::class, $e->getPrevious());
+        }
+    }
+
     protected function getApp(array $userConfig)
     {
         $app = new Container;