Refactor channels (#17)

* slim channel manager * rename connection manager * add channel connection manager * channels manage connections * Fix code styling
laravel · Nov 20, 2023 · b07fa67 · b07fa67
1 parent c69b7b4
commit b07fa67
Show file tree

Hide file tree

Showing 19 changed files with 252 additions and 237 deletions.
diff --git a/src/Channels/Channel.php b/src/Channels/Channel.php
@@ -4,16 +4,23 @@
 
 use Exception;
 use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\App;
 use Laravel\Reverb\Application;
-use Laravel\Reverb\Contracts\ChannelManager;
+use Laravel\Reverb\Contracts\ChannelConnectionManager;
 use Laravel\Reverb\Contracts\Connection;
 use Laravel\Reverb\Output;
 
 class Channel
 {
+    /**
+     * The channel connections.
+     *
+     * @var \Laravel\Reverb\Contracts\ChannelConnectionManager
+     */
+    protected $connections;
+
     public function __construct(protected string $name)
     {
+        $this->connections = app(ChannelConnectionManager::class);
     }
 
     /**
@@ -24,32 +31,36 @@ public function name(): string
         return $this->name;
     }
 
+    /**
+     * Get all connections for the channel.
+     */
+    public function connections(): array
+    {
+        return $this->connections->all();
+    }
+
     /**
      * Subscribe to the given channel.
      */
     public function subscribe(Connection $connection, string $auth = null, string $data = null): void
     {
-        App::make(ChannelManager::class)
-            ->for($connection->app())
-            ->subscribe($this, $connection, $data ? json_decode($data, true) : []);
+        $this->connections->add($connection, $data ? json_decode($data, true) : []);
     }
 
     /**
      * Unsubscribe from the given channel.
      */
     public function unsubscribe(Connection $connection): void
     {
-        App::make(ChannelManager::class)
-            ->for($connection->app())
-            ->unsubscribe($this, $connection);
+        $this->connections->remove($connection);
     }
 
     /**
      * Send a message to all connections subscribed to the channel.
      */
     public function broadcast(Application $app, array $payload, Connection $except = null): void
     {
-        collect(App::make(ChannelManager::class)->for($app)->connections($this))
+        collect($this->connections())
             ->each(function ($connection) use ($payload, $except) {
                 if ($except && $except->id() === $connection->id()) {
                     return;

diff --git a/src/Concerns/EnsuresIntegrity.php b/src/Concerns/EnsuresIntegrity.php
diff --git a/src/Contracts/ChannelConnectionManager.php b/src/Contracts/ChannelConnectionManager.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Laravel\Reverb\Contracts;
+
+interface ChannelConnectionManager
+{
+    /**
+     * Add a connection.
+     */
+    public function add(Connection $connection): void;
+
+    /**
+     * Remove a connection.
+     */
+    public function remove(Connection $connection): void;
+
+    /**
+     * Get all the connections.
+     */
+    public function all(): array;
+
+    /**
+     * Flush the channel connection manager.
+     */
+    public function flush(): void;
+}
diff --git a/src/Contracts/ChannelManager.php b/src/Contracts/ChannelManager.php
@@ -5,7 +5,6 @@
 use Illuminate\Support\Collection;
 use Laravel\Reverb\Application;
 use Laravel\Reverb\Channels\Channel;
-use Laravel\Reverb\Managers\Connections;
 
 interface ChannelManager
 {
@@ -19,32 +18,20 @@ public function app(): ?Application;
      */
     public function for(Application $application): ChannelManager;
 
-    /**
-     * Subscribe to a channel.
-     */
-    public function subscribe(Channel $channel, Connection $connection, array $data = []): void;
-
-    /**
-     * Unsubscribe from a channel.
-     */
-    public function unsubscribe(Channel $channel, Connection $connection): void;
-
     /**
      * Get all the channels.
      */
     public function all(): Collection;
 
     /**
-     * Unsubscribe from all channels.
+     * Find the given channel
      */
-    public function unsubscribeFromAll(Connection $connection): void;
+    public function find(string $channel): Channel;
 
     /**
-     * Get all connections for the given channel.
-     *
-     * @return <array string, \Laravel\Reverb\Connection>
+     * Unsubscribe from all channels.
      */
-    public function connections(Channel $channel): array;
+    public function unsubscribeFromAll(Connection $connection): void;
 
     /**
      * Flush the channel manager repository.

diff --git a/src/Event.php b/src/Event.php
@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\App;
-use Laravel\Reverb\Channels\ChannelBroker;
+use Laravel\Reverb\Contracts\ChannelManager;
 use Laravel\Reverb\Contracts\Connection;
 use Laravel\Reverb\Contracts\ServerProvider;
 
@@ -38,7 +38,7 @@ public static function dispatchSynchronously(Application $app, array $payload, C
 
         foreach ($channels as $channel) {
             unset($payload['channels']);
-            $channel = ChannelBroker::create($channel);
+            $channel = app(ChannelManager::class)->find($channel);
             $payload['channel'] = $channel->name();
 
             $channel->broadcast($app, $payload, $connection);

diff --git a/src/Managers/ArrayChannelConnectionManager.php b/src/Managers/ArrayChannelConnectionManager.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace Laravel\Reverb\Managers;
+
+use Laravel\Reverb\Contracts\ChannelConnectionManager;
+use Laravel\Reverb\Contracts\Connection;
+
+class ArrayChannelConnectionManager implements ChannelConnectionManager
+{
+    /**
+     * Connection store.
+     *
+     * @var array<string, array<string, \Laravel\Reverb\Connection>>
+     */
+    protected $connections = [];
+
+    /**
+     * Add a connection.
+     */
+    public function add(Connection $connection): void
+    {
+        $this->connections[$connection->identifier()] = $connection;
+    }
+
+    /**
+     * Remove a connection.
+     */
+    public function remove(Connection $connection): void
+    {
+        unset($this->connections[$connection->identifier()]);
+    }
+
+    /**
+     * Get all the connections.
+     */
+    public function all(): array
+    {
+        return $this->connections;
+    }
+
+    /**
+     * Flush the channel connection manager.
+     */
+    public function flush(): void
+    {
+        $this->connections = [];
+    }
+}
diff --git a/src/Managers/ArrayChannelManager.php b/src/Managers/ArrayChannelManager.php
@@ -0,0 +1,108 @@
+<?php
+
+namespace Laravel\Reverb\Managers;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\App;
+use Laravel\Reverb\Application;
+use Laravel\Reverb\Channels\Channel;
+use Laravel\Reverb\Channels\ChannelBroker;
+use Laravel\Reverb\Concerns\InteractsWithApplications;
+use Laravel\Reverb\Contracts\ApplicationProvider;
+use Laravel\Reverb\Contracts\ChannelManager as ChannelManagerInterface;
+use Laravel\Reverb\Contracts\Connection;
+
+class ArrayChannelManager implements ChannelManagerInterface
+{
+    use InteractsWithApplications;
+
+    /**
+     * Application store.
+     *
+     * @var array<string, array<string, array<string, \Laravel\Reverb\Channels\Channel>>>
+     */
+    protected $applications = [];
+
+    /**
+     * The appliation instance.
+     *
+     * @var \Laravel\Reverb\Application
+     */
+    protected $application;
+
+    /**
+     * Get the application instance.
+     */
+    public function app(): ?Application
+    {
+        return $this->application;
+    }
+
+    /**
+     * Get all the channels.
+     */
+    public function all(): Collection
+    {
+        return collect($this->channels());
+    }
+
+    /**
+     * Find the given channel
+     */
+    public function find(string $channel): Channel
+    {
+        return $this->channels($channel);
+    }
+
+    /**
+     * Unsubscribe from all channels.
+     */
+    public function unsubscribeFromAll(Connection $connection): void
+    {
+        foreach ($this->channels() as $channel) {
+            $channel->unsubscribe($connection);
+        }
+    }
+
+    /**
+     * Get the given channel.
+     */
+    public function channel(string $channel): array
+    {
+        return $this->channels($channel);
+    }
+
+    /**
+     * Get the channels.
+     */
+    public function channels(string $channel = null): array|Channel
+    {
+        if (! isset($this->applications[$this->application->id()])) {
+            $this->applications[$this->application->id()] = [];
+        }
+
+        $channels = $this->applications[$this->application->id()];
+
+        if ($channel) {
+            if (! isset($channels[$channel])) {
+                $this->applications[$this->application->id()][$channel] = ChannelBroker::create($channel);
+            }
+
+            return $this->applications[$this->application->id()][$channel];
+        }
+
+        return $channels ?: [];
+    }
+
+    /**
+     * Flush the channel manager repository.
+     */
+    public function flush(): void
+    {
+        App::make(ApplicationProvider::class)
+            ->all()
+            ->each(function (Application $application) {
+                $this->applications[$application->id()] = [];
+            });
+    }
+}
diff --git a/src/Managers/ConnectionManager.php → src/Managers/ArrayConnectionManager.php b/src/Managers/ConnectionManager.php → src/Managers/ArrayConnectionManager.php
@@ -3,15 +3,14 @@
 namespace Laravel\Reverb\Managers;
 
 use Closure;
-use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Support\Facades\App;
 use Laravel\Reverb\Application;
 use Laravel\Reverb\Concerns\InteractsWithApplications;
 use Laravel\Reverb\Contracts\ApplicationProvider;
 use Laravel\Reverb\Contracts\Connection;
 use Laravel\Reverb\Contracts\ConnectionManager as ConnectionManagerInterface;
 
-class ConnectionManager implements ConnectionManagerInterface
+class ArrayConnectionManager implements ConnectionManagerInterface
 {
     use InteractsWithApplications;