[4.x] BroadcastingConfigBootstrapper: fix central instances persisting in tenant context

src/Bootstrappers/BroadcastingConfigBootstrapper.php

@@ -4,14 +4,19 @@
 
 namespace Stancl\Tenancy\Bootstrappers;
 
+use Illuminate\Broadcasting\Broadcasters\Broadcaster;
 use Illuminate\Broadcasting\BroadcastManager;
 use Illuminate\Config\Repository;
-use Illuminate\Contracts\Broadcasting\Broadcaster;
+use Illuminate\Contracts\Broadcasting\Broadcaster as BroadcasterContract;
 use Illuminate\Foundation\Application;
+use Illuminate\Support\Facades\Broadcast;
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 use Stancl\Tenancy\Contracts\Tenant;
-use Stancl\Tenancy\Overrides\TenancyBroadcastManager;
 
+/**
+ * Maps tenant credentials to the broadcasting config and rebinds BroadcastManager
+ * and Broadcaster so that broadcasters get resolved using the tenant credentials.
+ */
 class BroadcastingConfigBootstrapper implements TenancyBootstrapper
 {
     /**
@@ -21,14 +26,16 @@ class BroadcastingConfigBootstrapper implements TenancyBootstrapper
      * [
      *     'config.key.name' => 'tenant_property',
      * ]
+     *
+     * $tenant->tenant_property will be mapped to config('config.key.name') when tenancy is initialized.
      */
     public static array $credentialsMap = [];
 
     public static string|null $broadcaster = null;
 
     protected array $originalConfig = [];
     protected BroadcastManager|null $originalBroadcastManager = null;
-    protected Broadcaster|null $originalBroadcaster = null;
+    protected BroadcasterContract|null $originalBroadcaster = null;
 
     public static array $mapPresets = [
         'pusher' => [
@@ -54,27 +61,72 @@ public function __construct(
         protected Application $app
     ) {
         static::$broadcaster ??= $config->get('broadcasting.default');
-        static::$credentialsMap = array_merge(static::$credentialsMap, static::$mapPresets[static::$broadcaster] ?? []);
+        static::$credentialsMap = array_merge(static::$mapPresets[static::$broadcaster] ?? [], static::$credentialsMap);
     }
 
     public function bootstrap(Tenant $tenant): void
     {
         $this->originalBroadcastManager = $this->app->make(BroadcastManager::class);
-        $this->originalBroadcaster = $this->app->make(Broadcaster::class);
+        $this->originalBroadcaster = $this->app->make(BroadcasterContract::class);
 
         $this->setConfig($tenant);
 
-        // Make BroadcastManager resolve to a custom BroadcastManager which makes the broadcasters use the tenant credentials
-        $this->app->extend(BroadcastManager::class, function (BroadcastManager $broadcastManager) {
-            return new TenancyBroadcastManager($this->app);
+        // Make BroadcastManager resolve to a fresh manager with no cached broadcasters,
+        // so that its broadcasters get resolved using the updated (tenant) broadcasting
+        // config and stay cached for the duration of the tenant's context.
+        $this->app->extend(BroadcastManager::class, function (BroadcastManager $centralManager) {
+            $tenantManager = new BroadcastManager($this->app);
+
+            // Pass the custom driver creators registered in the central context to the new manager
+            // so that custom drivers work in tenant context without having to re-register the creators manually.
+            foreach (invade($centralManager)->customCreators as $driver => $creator) {
+                $tenantManager->extend($driver, $creator);
+            }
+
+            return $tenantManager;
+        });
+
+        // Swap the currently bound Broadcaster singleton (resolved earlier with the central credentials)
+        // for the tenant BroadcastManager's default broadcaster, so that anything resolving the Broadcaster
+        // contract gets the same tenant broadcaster that the manager uses, instead of the stale central one.
+        $this->app->extend(BroadcasterContract::class, function (BroadcasterContract $centralBroadcaster) {
+            $tenantBroadcaster = $this->app->make(BroadcastManager::class)->connection();
+
+            // The newly resolved broadcaster doesn't have any channel auth closures registered, so the
+            // closures registered in central context (e.g. in routes/channels.php) have to be passed to it
+            // manually, otherwise, Broadcast::auth() would throw a 403 for those channels.
+            // Since Laravel only ever uses the default broadcaster's channel auth closures for broadcasting auth,
+            // we only have to pass the channel closures to the default broadcaster.
+            //
+            // The $channels property and the channel() method aren't part of the Broadcaster contract -- they come
+            // from the abstract Broadcaster class, so the closures can only be copied between broadcasters extending it
+            // (which all of Laravel's default broadcasters, e.g. PusherBroadcaster, do).
+            if ($centralBroadcaster instanceof Broadcaster && $tenantBroadcaster instanceof Broadcaster) {
+                // invade() because channels can't be retrieved through any of the broadcaster's public methods
+                $centralBroadcaster = invade($centralBroadcaster);
+
+                foreach ($centralBroadcaster->channels as $channel => $callback) {
+                    $tenantBroadcaster->channel($channel, $callback, $centralBroadcaster->retrieveChannelOptions($channel));
+                }
+            }
+
+            return $tenantBroadcaster;
         });
+
+        // Extending the binding doesn't update the Broadcast facade's cached instance,
+        // so clear it to make the facade re-resolve to the tenant BroadcastManager instead of the central
+        // one — e.g. in the Broadcast::auth() call in BroadcastController (/broadcasting/auth).
+        Broadcast::clearResolvedInstance();
     }
 
     public function revert(): void
     {
-        // Change the BroadcastManager and Broadcaster singletons back to what they were before initializing tenancy
-        $this->app->singleton(BroadcastManager::class, fn (Application $app) => $this->originalBroadcastManager);
-        $this->app->singleton(Broadcaster::class, fn (Application $app) => $this->originalBroadcaster);
+        // Revert the bound BroadcastManager and Broadcaster singletons back to their original state
+        $this->app->singleton(BroadcastManager::class, fn () => $this->originalBroadcastManager);
+        $this->app->singleton(BroadcasterContract::class, fn () => $this->originalBroadcaster);
+
+        // Clear the resolved Broadcast facade instance so that it gets re-resolved as the central BroadcastManager
+        Broadcast::clearResolvedInstance();
 
         $this->unsetConfig();
     }

tests/Bootstrappers/BroadcastChannelPrefixBootstrapperTest.php

@@ -16,6 +16,9 @@
 use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\BroadcastChannelPrefixBootstrapper;
 use function Stancl\Tenancy\Tests\pest;
+use Illuminate\Broadcasting\Broadcasters\NullBroadcaster;
+use Illuminate\Support\Facades\Broadcast;
+use Illuminate\Support\Collection;
 
 beforeEach(function () {
     Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
@@ -137,3 +140,102 @@ protected function formatChannels(array $channels)
     expect(app(BroadcastManager::class)->driver())->toBe($broadcaster);
     expect(invade(app(BroadcastManager::class)->driver())->formatChannels($channelNames))->toEqual($channelNames);
 });
+
+test('broadcasting channel helpers register channels correctly', function() {
+    config([
+        'broadcasting.default' => $driver = 'testing',
+        'broadcasting.connections.testing.driver' => $driver,
+    ]);
+
+    config(['tenancy.bootstrappers' => [DatabaseTenancyBootstrapper::class]]);
+
+    Schema::create('users', function (Blueprint $table) {
+        $table->increments('id');
+        $table->string('name');
+        $table->string('email')->unique();
+        $table->string('password');
+        $table->rememberToken();
+        $table->timestamps();
+    });
+
+    $centralUser = User::create(['name' => 'central', 'email' => 'test@central.cz', 'password' => 'test']);
+    $tenant = Tenant::create();
+
+    migrateTenants();
+
+    tenancy()->initialize($tenant);
+
+    // Same ID as $centralUser
+    $tenantUser = User::create(['name' => 'tenant', 'email' => 'test@tenant.cz', 'password' => 'test']);
+
+    tenancy()->end();
+
+    /** @var BroadcastManager $broadcastManager */
+    $broadcastManager = app(BroadcastManager::class);
+
+    // Use a driver with no channels
+    $broadcastManager->extend($driver, fn () => new NullBroadcaster);
+
+    $getChannels = fn (): Collection => $broadcastManager->driver($driver)->getChannels();
+
+    expect($getChannels())->toBeEmpty();
+
+    // Basic channel registration
+    Broadcast::channel($channelName = 'user.{userName}', $channelClosure = function ($user, $userName) {
+        return User::firstWhere('name', $userName)?->is($user) ?? false;
+    });
+
+    // Check if the channel is registered
+    $centralChannelClosure = $getChannels()->first(fn ($closure, $name) => $name === $channelName);
+    expect($centralChannelClosure)->not()->toBeNull();
+
+    // Channel closures work as expected (running in central context)
+    expect($centralChannelClosure($centralUser, $centralUser->name))->toBeTrue();
+    expect($centralChannelClosure($centralUser, $tenantUser->name))->toBeFalse();
+
+    // Register a tenant broadcasting channel (almost identical to the original channel, just able to accept the tenant key)
+    tenant_channel($channelName, $channelClosure);
+
+    // Tenant channel registered – its name is correctly prefixed ("{tenant}.user.{userName}")
+    $tenantChannelClosure = $getChannels()->first(fn ($closure, $name) => $name === "{tenant}.$channelName");
+    expect($tenantChannelClosure)->toBe($centralChannelClosure);
+
+    // The tenant channels are prefixed with '{tenant}.'
+    // They accept the tenant key, but their closures only run in tenant context when tenancy is initialized
+    // The regular channels don't accept the tenant key, but they also respect the current context
+    // The tenant key is used solely for the name prefixing – the closures can still run in the central context
+    tenant_channel($channelName, $tenantChannelClosure = function ($user, $tenant, $userName) {
+        return User::firstWhere('name', $userName)?->is($user) ?? false;
+    });
+
+    // Retrieve the stored closure to verify that re-registering the channel replaced it
+    // (asserting on $tenantChannelClosure wouldn't tell us what tenant_channel() actually stored)
+    $reregisteredTenantChannelClosure = $getChannels()->first(fn ($closure, $name) => $name === "{tenant}.$channelName");
+
+    expect($reregisteredTenantChannelClosure)
+        ->toBe($tenantChannelClosure)
+        ->not()->toBe($centralChannelClosure);
+
+    expect($reregisteredTenantChannelClosure($centralUser, $tenant->getTenantKey(), $centralUser->name))->toBeTrue();
+    expect($reregisteredTenantChannelClosure($centralUser, $tenant->getTenantKey(), $tenantUser->name))->toBeFalse();
+
+    tenancy()->initialize($tenant);
+
+    // The channel closure runs in the tenant context
+    // Only the tenant user is available
+    expect($tenantChannelClosure($centralUser, $tenant->getTenantKey(), $tenantUser->name))->toBeFalse();
+    expect($tenantChannelClosure($tenantUser, $tenant->getTenantKey(), $tenantUser->name))->toBeTrue();
+
+    // Use a new channel instance to delete the previously registered channels before testing the global_channel helper
+    $broadcastManager->purge($driver);
+    $broadcastManager->extend($driver, fn () => new NullBroadcaster);
+
+    expect($getChannels())->toBeEmpty();
+
+    // Global channel helper prefixes the channel name with 'global__'
+    global_channel($channelName, $channelClosure);
+
+    // Channel prefixed with 'global__' found
+    $foundChannelClosure = $getChannels()->first(fn ($closure, $name) => $name === 'global__' . $channelName);
+    expect($foundChannelClosure)->not()->toBeNull();
+});