* broadcaster: refactor from Pusher to AnyCable mode

Author: palkan

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.2.0
+
+- Refactor broadcaster to work with AnyCable Echo adapter (Reverb-compatible Echo adapters don't require a custom broadcaster anymore).
+
 ## 0.1.2
 
 - Use Reverb env vars as defaults in `anycable:server`.

README.md

@@ -2,16 +2,11 @@
 
 # AnyCable Laravel Broadcaster
 
-A Laravel broadcaster implementation to use [AnyCable](https://anycable.io/) as a WebSocket server.
-
-The broadcaster allows you to use AnyCable as a drop-in replacement for Reverb, or Pusher, or whatever is supported by Laravel Echo. By "drop-in", we mean that no client-side changes required to use AnyCable, all you need is to update the server configuration (and, well, launch an AnyCable server).
+A Laravel broadcaster implementation to use [AnyCable](https://anycable.io/) as a WebSocket server with Laravel Echo clients. For client-side integration, see [@anycable/echo][] package.
 
 > [!TIP]
 > The quickest way to get started with AnyCable server is to use our free managed offering: [plus.anycable.io](https://plus.anycable.io)
 
-> [!NOTE]
-> AnyCable Laravel support is still in its early days. Please, let us know if anything goes wrong. See also the [limitations](#limitations) section below.
-
 ## Requirements
 
 - PHP 8.2+
@@ -57,51 +52,22 @@ That's a minimal configuration, all AnyCable related parameters would be inferre
 ]
 ```
 
-Your client-side Echo configuration can stay almost unchanged (in case you used Reverb):
+On the client-side, configure Echo to use AnyCable adapter:
 
 ```js
 import Echo from "laravel-echo";
+import { EchoCable } from "@anycable/echo";
 
-// We use Pusher protocol for now
-import Pusher from "pusher-js";
-window.Pusher = Pusher;
 
 window.Echo = new Echo({
-    broadcaster: "reverb", // reverb or pusher would work
-    key: import.meta.env.VITE_REVERB_APP_KEY,
-    wsHost: import.meta.env.VITE_REVERB_HOST,
-    wsPort: import.meta.env.VITE_REVERB_PORT ?? 80,
-    wssPort: import.meta.env.VITE_REVERB_PORT ?? 443,
-    forceTLS: (import.meta.env.VITE_REVERB_SCHEME ?? "https") === "https",
-    enabledTransports: ["ws", "wss"],
+    broadcaster: EchoCable,
+    cableOptions: {
+        url: url: import.meta.env.VITE_WEBSOCKET_URL || 'ws://localhost:8080/cable',
+    },
+    // other configuration options such as auth, etc
 });
 ```
 
-Just make sure you point to to the AnyCable server (locally it runs on the same host and port as Reverb). You must also **configure AnyCable to use the same app key** as `VITE_REVERB_APP_KEY`:
-
-```sh
-anycable-go --pusher-app-key=my-app-key
-
-# or
-ANYCABLE_PUSHER_APP_KEY=my-app-key anycable-go
-```
-
-To use public channels, make sure you have enabled them in AnyCable:
-
-
-```sh
-anycable-go --public_streams
-
-# or full public mode
-anycable-go --public
-
-# or
-ANYCABLE_PUBLIC_STREAMS=true anycable-go
-
-# or
-ANYCABLE_PUBLIC=true anycable-go
-```
-
 ## Usage
 
 You can use Laravel's broadcasting features as you normally would:
@@ -143,7 +109,7 @@ php artisan anycable:server -- --public_streams --pusher_app_key=my-app-key
 
 ### Private Channels
 
-AnyCable supports private channels. To use them, you need to set the `ANYCABLE_SECRET` environment variable.
+AnyCable supports private and presence channels. To use them, you need to set the `ANYCABLE_SECRET` environment variable.
 
 Then, don't forget to add authorization callbacks like this:
 
@@ -153,14 +119,6 @@ Broadcast::channel('private-channel', function ($user) {
 });
 ```
 
-## Limitations
-
-- Presence channels are not supported yet.
-
-- Only HTTP broadcasting adapter for AnyCable is supported for now.
-
-- Pusher's signing functionality is not supported by AnyCable yet (is it used by Laravel at all?).
-
 ## Contributing
 
 Contributions are welcomed! All you need to start developing the project locally is PHP 8.2+, Composer and:
@@ -179,3 +137,5 @@ composer lint
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE) for more information.
+
+[@anycable/echo]: https://github.com/anycable/anycable-client/tree/master/packages/echo

src/Broadcasting/AnyCableBroadcaster.php

@@ -38,10 +38,20 @@ public function __construct(Client $httpClient, array $config)
      */
     public function validAuthenticationResponse($request, $result)
     {
-        if (str_starts_with($request->channel_name, 'private') && isset($this->config['secret']) && $this->config['secret']) {
+        if ((str_starts_with($request->channel_name, 'private-') || str_starts_with($request->channel_name, 'presence-')) && isset($this->config['secret']) && $this->config['secret']) {
             $signed_stream_name = $this->client->signStream($request->channel_name);
 
-            return ['auth' => $signed_stream_name];
+            if (str_starts_with($request->channel_name, 'presence-')) {
+                $user = $this->retrieveUser($request, $request->channel_name);
+
+                $broadcastIdentifier = method_exists($user, 'getAuthIdentifierForBroadcasting')
+                    ? $user->getAuthIdentifierForBroadcasting()
+                    : $user->getAuthIdentifier();
+
+                return ['signed_stream_name' => $signed_stream_name, 'presence' => array_merge(['id' => $broadcastIdentifier], $result)];
+            }
+
+            return ['signed_stream_name' => $signed_stream_name];
         }
 
         return [];
@@ -56,7 +66,7 @@ public function broadcast(array $channels, $event, array $payload = [])
             foreach ($channels as $channel) {
                 $result = $this->client->broadcastEvent($channel, $event, $payload);
 
-                if (! $result['success']) {
+                if ($result['status'] != 201) {
                     Log::error('AnyCable broadcast failed', [
                         'channel' => $channel,
                         'event' => $event,

src/Commands/AnyCableServerCommand.php

@@ -212,30 +212,35 @@ protected function runBinary($binaryPath)
         $env = $_ENV;
 
         // Set ANYCABLE_BROADCAST_ADAPTER=http if not set
-        if (!isset($env['ANYCABLE_BROADCAST_ADAPTER'])) {
+        if (! isset($env['ANYCABLE_BROADCAST_ADAPTER'])) {
             $env['ANYCABLE_BROADCAST_ADAPTER'] = 'http';
         }
 
         // Set ANYCABLE_PUSHER_APP_ID to REVERB_APP_ID if not set and the latter exists
-        if (!isset($env['ANYCABLE_PUSHER_APP_ID']) && isset($env['REVERB_APP_ID'])) {
+        if (! isset($env['ANYCABLE_PUSHER_APP_ID']) && isset($env['REVERB_APP_ID'])) {
             $env['ANYCABLE_PUSHER_APP_ID'] = $env['REVERB_APP_ID'];
         }
 
         // Set ANYCABLE_PUSHER_APP_KEY to REVERB_APP_KEY if not set and the latter exists
-        if (!isset($env['ANYCABLE_PUSHER_APP_KEY']) && isset($env['REVERB_APP_KEY'])) {
+        if (! isset($env['ANYCABLE_PUSHER_APP_KEY']) && isset($env['REVERB_APP_KEY'])) {
             $env['ANYCABLE_PUSHER_APP_KEY'] = $env['REVERB_APP_KEY'];
         }
 
         // Set ANYCABLE_PUSHER_SECRET to REVERB_APP_SECRET if not set and the latter exists
-        if (!isset($env['ANYCABLE_PUSHER_SECRET']) && isset($env['REVERB_APP_SECRET'])) {
+        if (! isset($env['ANYCABLE_PUSHER_SECRET']) && isset($env['REVERB_APP_SECRET'])) {
             $env['ANYCABLE_PUSHER_SECRET'] = $env['REVERB_APP_SECRET'];
         }
 
         // Set ANYCABLE_PRESETS to broker if not set
-        if (!isset($env['ANYCABLE_PRESETS'])) {
+        if (! isset($env['ANYCABLE_PRESETS'])) {
             $env['ANYCABLE_PRESETS'] = 'broker';
         }
 
+        // Enable whispering by default
+        if (! isset($env['ANYCABLE_STREAMS_WHISPER'])) {
+            $env['ANYCABLE_STREAMS_WHISPER'] = 'true';
+        }
+
         $process = new Process($args, null, $env);
         $process->setTimeout(null);
         $process->setTty(Process::isTtySupported());

tests/Unit/AnyCableBroadcasterTest.php

@@ -59,20 +59,16 @@ public function test_valid_authentication_response_for_private_channel()
         $result = $broadcaster->validAuthenticationResponse($request, 'user-auth-data');
 
         $this->assertIsArray($result);
-        $this->assertArrayHasKey('auth', $result);
+        $this->assertArrayHasKey('signed_stream_name', $result);
 
-        // Verify the auth signature is correctly formatted
-        $auth = $result['auth'];
-        $this->assertStringContainsString('--', $auth);
+        $signedName = $result['signed_stream_name'];
+        $this->assertStringContainsString('--', $signedName);
 
-        // Split and verify the signature
-        [$encoded, $digest] = explode('--', $auth);
+        [$encoded, $digest] = explode('--', $signedName);
 
-        // Verify encoded is valid base64
         $decoded = base64_decode($encoded, true);
         $this->assertNotFalse($decoded);
 
-        // Verify decoded is the original channel name
         $this->assertEquals('private-channel', json_decode($decoded));
     }