Adds support for Pusher cache channels (#25)

* adds cache channels

* send empty cache message

* stub private and presence cache channels

* wip

* Fix code styling

src/Channels/CacheChannel.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Laravel\Reverb\Channels;
+
+use Laravel\Reverb\Contracts\Connection;
+
+class CacheChannel extends Channel
+{
+    /**
+     * Data from last event triggered.
+     */
+    protected ?array $payload = null;
+
+    /**
+     * Send a message to all connections subscribed to the channel.
+     */
+    public function broadcast(array $payload, Connection $except = null): void
+    {
+        $this->payload = $payload;
+
+        parent::broadcast($payload, $except);
+    }
+
+    /**
+     * Broadcast a message triggered from an internal source.
+     */
+    public function broadcastInternally(array $payload, Connection $except = null): void
+    {
+        parent::broadcast($payload, $except);
+    }
+
+    /**
+     * Determine if the channel has a cached payload.
+     */
+    public function hasCachedPayload(): bool
+    {
+        return $this->payload !== null;
+    }
+
+    /**
+     * Get the cached payload.
+     */
+    public function cachedPayload(): ?array
+    {
+        return $this->payload;
+    }
+}

src/Channels/Channel.php

@@ -107,6 +107,14 @@ public function broadcast(array $payload, Connection $except = null): void
         }
     }
 
+    /**
+     * Broadcast a message triggered from an internal source.
+     */
+    public function broadcastInternally(array $payload, Connection $except = null): void
+    {
+        $this->broadcast($payload, $except);
+    }
+
     /**
      * Get the data associated with the channel.
      */

src/Channels/ChannelBroker.php

@@ -11,9 +11,12 @@ class ChannelBroker
      */
     public static function create(string $name): Channel
     {
-        return match (Str::before($name, '-')) {
-            'private' => new PrivateChannel($name),
-            'presence' => new PresenceChannel($name),
+        return match (true) {
+            Str::startsWith($name, 'private-cache-') => new PrivateCacheChannel($name),
+            Str::startsWith($name, 'presence-cache-') => new PresenceCacheChannel($name),
+            Str::startsWith($name, 'cache') => new CacheChannel($name),
+            Str::startsWith($name, 'private') => new PrivateChannel($name),
+            Str::startsWith($name, 'presence') => new PresenceChannel($name),
             default => new Channel($name),
         };
     }

src/Channels/Concerns/InteractsWithPresenceChannels.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Laravel\Reverb\Channels\Concerns;
+
+use Laravel\Reverb\Contracts\Connection;
+
+trait InteractsWithPresenceChannels
+{
+    use InteractsWithPrivateChannels;
+
+    /**
+     * Subscribe to the given channel.
+     */
+    public function subscribe(Connection $connection, string $auth = null, string $data = null): void
+    {
+        $this->verify($connection, $auth, $data);
+
+        parent::subscribe($connection, $auth, $data);
+
+        parent::broadcastInternally(
+            [
+                'event' => 'pusher_internal:member_added',
+                'data' => $data ? json_decode($data, true) : [],
+                'channel' => $this->name(),
+            ],
+            $connection
+        );
+    }
+
+    /**
+     * Unsubscribe from the given channel.
+     */
+    public function unsubscribe(Connection $connection): void
+    {
+        if (! $subscription = $this->connections->find($connection)) {
+            parent::unsubscribe($connection);
+
+            return;
+        }
+
+        if ($userId = $subscription->data('user_id')) {
+            parent::broadcast(
+                [
+                    'event' => 'pusher_internal:member_removed',
+                    'data' => ['user_id' => $userId],
+                    'channel' => $this->name(),
+                ],
+                $connection
+            );
+        }
+
+        parent::unsubscribe($connection);
+    }
+
+    /**
+     * Get the data associated with the channel.
+     */
+    public function data(): array
+    {
+        $connections = collect($this->connections->all())
+            ->map(fn ($connection) => $connection->data());
+
+        if ($connections->contains(fn ($connection) => ! isset($connection['user_id']))) {
+            return [
+                'presence' => [
+                    'count' => 0,
+                    'ids' => [],
+                    'hash' => [],
+                ],
+            ];
+        }
+
+        return [
+            'presence' => [
+                'count' => $connections->count() ?? 0,
+                'ids' => $connections->map(fn ($connection) => $connection['user_id'])->all(),
+                'hash' => $connections->keyBy('user_id')->map->user_info->toArray(),
+            ],
+        ];
+    }
+}

src/Channels/Concerns/InteractsWithPrivateChannels.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Laravel\Reverb\Channels\Concerns;
+
+use Illuminate\Support\Str;
+use Laravel\Reverb\Contracts\Connection;
+use Laravel\Reverb\Exceptions\ConnectionUnauthorized;
+
+trait InteractsWithPrivateChannels
+{
+    /**
+     * Subscribe to the given channel.
+     */
+    public function subscribe(Connection $connection, string $auth = null, string $data = null): void
+    {
+        $this->verify($connection, $auth, $data);
+
+        parent::subscribe($connection, $auth, $data);
+    }
+
+    /**
+     * Deteremine whether the given auth token is valid.
+     */
+    protected function verify(Connection $connection, string $auth, string $data = null): bool
+    {
+        $signature = "{$connection->id()}:{$this->name()}";
+
+        if ($data) {
+            $signature .= ":{$data}";
+        }
+
+        if (! hash_equals(
+            hash_hmac(
+                'sha256',
+                $signature,
+                $connection->app()->secret(),
+            ),
+            Str::after($auth, ':')
+        )) {
+            throw new ConnectionUnauthorized;
+        }
+
+        return true;
+    }
+}

src/Channels/PresenceCacheChannel.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Laravel\Reverb\Channels;
+
+use Laravel\Reverb\Channels\Concerns\InteractsWithPresenceChannels;
+
+class PresenceCacheChannel extends CacheChannel
+{
+    use InteractsWithPresenceChannels;
+}

src/Channels/PresenceChannel.php

@@ -2,76 +2,9 @@
 
 namespace Laravel\Reverb\Channels;
 
-use Laravel\Reverb\Contracts\Connection;
+use Laravel\Reverb\Channels\Concerns\InteractsWithPresenceChannels;
 
 class PresenceChannel extends PrivateChannel
 {
-    /**
-     * Subscribe to the given channel.
-     */
-    public function subscribe(Connection $connection, string $auth = null, string $data = null): void
-    {
-        parent::subscribe($connection, $auth, $data);
-
-        $this->broadcast(
-            [
-                'event' => 'pusher_internal:member_added',
-                'data' => $data ? json_decode($data, true) : [],
-                'channel' => $this->name(),
-            ],
-            $connection
-        );
-    }
-
-    /**
-     * Unsubscribe from the given channel.
-     */
-    public function unsubscribe(Connection $connection): void
-    {
-        if (! $subscription = $this->connections->find($connection)) {
-            parent::unsubscribe($connection);
-
-            return;
-        }
-
-        if ($userId = $subscription->data('user_id')) {
-            $this->broadcast(
-                [
-                    'event' => 'pusher_internal:member_removed',
-                    'data' => ['user_id' => $userId],
-                    'channel' => $this->name(),
-                ],
-                $connection
-            );
-        }
-
-        parent::unsubscribe($connection);
-    }
-
-    /**
-     * Get the data associated with the channel.
-     */
-    public function data(): array
-    {
-        $connections = collect($this->connections->all())
-            ->map(fn ($connection) => $connection->data());
-
-        if ($connections->contains(fn ($connection) => ! isset($connection['user_id']))) {
-            return [
-                'presence' => [
-                    'count' => 0,
-                    'ids' => [],
-                    'hash' => [],
-                ],
-            ];
-        }
-
-        return [
-            'presence' => [
-                'count' => $connections->count() ?? 0,
-                'ids' => $connections->map(fn ($connection) => $connection['user_id'])->all(),
-                'hash' => $connections->keyBy('user_id')->map->user_info->toArray(),
-            ],
-        ];
-    }
+    use InteractsWithPresenceChannels;
 }

src/Channels/PrivateCacheChannel.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Laravel\Reverb\Channels;
+
+use Laravel\Reverb\Channels\Concerns\InteractsWithPrivateChannels;
+
+class PrivateCacheChannel extends CacheChannel
+{
+    use InteractsWithPrivateChannels;
+}

src/Channels/PrivateChannel.php

@@ -2,44 +2,9 @@
 
 namespace Laravel\Reverb\Channels;
 
-use Illuminate\Support\Str;
-use Laravel\Reverb\Contracts\Connection;
-use Laravel\Reverb\Exceptions\ConnectionUnauthorized;
+use Laravel\Reverb\Channels\Concerns\InteractsWithPrivateChannels;
 
 class PrivateChannel extends Channel
 {
-    /**
-     * Subscribe to the given channel.
-     */
-    public function subscribe(Connection $connection, string $auth = null, string $data = null): void
-    {
-        $this->verify($connection, $auth, $data);
-
-        parent::subscribe($connection, $auth, $data);
-    }
-
-    /**
-     * Deteremine whether the given auth token is valid.
-     */
-    protected function verify(Connection $connection, string $auth, string $data = null): bool
-    {
-        $signature = "{$connection->id()}:{$this->name()}";
-
-        if ($data) {
-            $signature .= ":{$data}";
-        }
-
-        if (! hash_equals(
-            hash_hmac(
-                'sha256',
-                $signature,
-                $connection->app()->secret(),
-            ),
-            Str::after($auth, ':')
-        )) {
-            throw new ConnectionUnauthorized;
-        }
-
-        return true;
-    }
+    use InteractsWithPrivateChannels;
 }