add support for server path prefix (#311)

Author: adrum

config/reverb.php

@@ -31,6 +31,7 @@
         'reverb' => [
             'host' => env('REVERB_SERVER_HOST', '0.0.0.0'),
             'port' => env('REVERB_SERVER_PORT', 8080),
+            'path' => env('REVERB_SERVER_PATH', ''),
             'hostname' => env('REVERB_HOST'),
             'options' => [
                 'tls' => [],

src/Servers/Reverb/Console/Commands/StartServer.php

@@ -31,6 +31,7 @@ class StartServer extends Command implements SignalableCommandInterface
     protected $signature = 'reverb:start
                 {--host= : The IP address the server should bind to}
                 {--port= : The port the server should listen on}
+                {--path= : The path the server should prefix to all routes}
                 {--hostname= : The hostname the server is accessible from}
                 {--debug : Indicates whether debug messages should be displayed in the terminal}';
 
@@ -57,6 +58,7 @@ public function handle(): void
         $server = ServerFactory::make(
             $host = $this->option('host') ?: $config['host'],
             $port = $this->option('port') ?: $config['port'],
+            $path = $this->option('path') ?: $config['path'] ?? '',
             $hostname = $this->option('hostname') ?: $config['hostname'],
             $config['max_request_size'] ?? 10_000,
             $config['options'] ?? [],
@@ -69,7 +71,7 @@ public function handle(): void
         $this->ensurePulseEventsAreCollected($loop, $config['pulse_ingest_interval']);
         $this->ensureTelescopeEntriesAreCollected($loop, $config['telescope_ingest_interval'] ?? 15);
 
-        $this->components->info('Starting '.($server->isSecure() ? 'secure ' : '')."server on {$host}:{$port}".(($hostname && $hostname !== $host) ? " ({$hostname})" : ''));
+        $this->components->info('Starting '.($server->isSecure() ? 'secure ' : '')."server on {$host}:{$port}{$path}".(($hostname && $hostname !== $host) ? " ({$hostname})" : ''));
 
         $server->start();
     }

src/Servers/Reverb/Factory.php

@@ -39,6 +39,7 @@ class Factory
     public static function make(
         string $host = '0.0.0.0',
         string $port = '8080',
+        string $path = '',
         ?string $hostname = null,
         int $maxRequestSize = 10_000,
         array $options = [],
@@ -48,7 +49,7 @@ public static function make(
         $loop = $loop ?: Loop::get();
 
         $router = match ($protocol) {
-            'pusher' => static::makePusherRouter(),
+            'pusher' => static::makePusherRouter($path),
             default => throw new InvalidArgumentException("Unsupported protocol [{$protocol}]."),
         };
 
@@ -67,7 +68,7 @@ public static function make(
     /**
      * Create a new WebSocket server for the Pusher protocol.
      */
-    public static function makePusherRouter(): Router
+    public static function makePusherRouter(string $path): Router
     {
         app()->singleton(
             ChannelManager::class,
@@ -84,13 +85,13 @@ public static function makePusherRouter(): Router
             fn () => new PusherPubSubIncomingMessageHandler,
         );
 
-        return new Router(new UrlMatcher(static::pusherRoutes(), new RequestContext));
+        return new Router(new UrlMatcher(static::pusherRoutes($path), new RequestContext));
     }
 
     /**
      * Generate the routes required to handle Pusher requests.
      */
-    protected static function pusherRoutes(): RouteCollection
+    protected static function pusherRoutes(string $path): RouteCollection
     {
         $routes = new RouteCollection;
 
@@ -104,6 +105,8 @@ protected static function pusherRoutes(): RouteCollection
         $routes->add('users_terminate', Route::post('/apps/{appId}/users/{userId}/terminate_connections', new UsersTerminateController));
         $routes->add('health_check', Route::get('/up', new HealthCheckController));
 
+        $routes->addPrefix($path);
+
         return $routes;
     }
 

tests/Feature/Protocols/Pusher/Reverb/ServerTest.php

@@ -5,6 +5,7 @@
 use Laravel\Reverb\Jobs\PruneStaleConnections;
 use Laravel\Reverb\Tests\ReverbTestCase;
 use Ratchet\RFC6455\Messaging\Frame;
+use React\Http\Message\ResponseException;
 use React\Promise\Deferred;
 
 use function Ratchet\Client\connect as wsConnect;
@@ -265,7 +266,7 @@
     expect(channels()->all())->toHaveCount(4);
     collect(channels()->all())->each(function ($channel) use ($connection) {
         expect($channel->connections())->toHaveCount(1);
-        expect(collect($channel->connections())->map(fn ($conn) => $conn->id()))->toContain($connection->socketId());
+        expect(collect($channel->connections())->map(fn($conn) => $conn->id()))->toContain($connection->socketId());
     });
 });
 
@@ -472,6 +473,29 @@
     expect($response->getBody()->getContents())->toBe('{}');
 });
 
+it('server listens on a specific path', function () {
+    $this->stopServer();
+    $this->startServer(path: 'ws');
+    $response = await($this->signedPostRequest('events', [
+        'name' => 'NewEvent',
+        'channel' => 'test-channel',
+        'data' => json_encode(['data' => 'data']),
+    ], pathPrefix: '/ws', appId: '654321', key: 'reverb-key-2', secret: 'reverb-secret-2'));
+
+    expect($response->getStatusCode())->toBe(200);
+    expect($response->getBody()->getContents())->toBe('{}');
+});
+
+it('returns an error when the path prefix is not included in the request', function () {
+    $this->stopServer();
+    $this->startServer(path: 'ws');
+    await($this->signedPostRequest('events', [
+        'name' => 'NewEvent',
+        'channel' => 'test-channel',
+        'data' => json_encode(['data' => 'data']),
+    ], appId: '654321', key: 'reverb-key-2', secret: 'reverb-secret-2'));
+})->throws(ResponseException::class, exceptionCode: 404);
+
 it('subscription_succeeded event contains unique list of users', function () {
     $data = ['user_id' => 1, 'user_info' => ['name' => 'Test User']];
     subscribe('presence-test-channel', data: $data);

tests/ReverbTestCase.php

@@ -83,10 +83,10 @@ public function usingRedis(): void
     /**
      * Start the WebSocket server.
      */
-    public function startServer(string $host = '0.0.0.0', string $port = '8080', int $maxRequestSize = 10_000): void
+    public function startServer(string $host = '0.0.0.0', string $port = '8080', string $path = '', int $maxRequestSize = 10_000): void
     {
         $this->resetFiber();
-        $this->server = Factory::make($host, $port, maxRequestSize: $maxRequestSize, loop: $this->loop);
+        $this->server = Factory::make($host, $port, $path, maxRequestSize: $maxRequestSize, loop: $this->loop);
     }
 
     /**
@@ -132,12 +132,12 @@ public function triggerEvent(string $channel, string $event, array $data = []):
     /**
      * Send a request to the server.
      */
-    public function request(string $path, string $method = 'GET', mixed $data = '', string $host = '0.0.0.0', string $port = '8080', string $appId = '123456'): PromiseInterface
+    public function request(string $path, string $method = 'GET', mixed $data = '', string $host = '0.0.0.0', string $port = '8080', string $pathPrefix = '', string $appId = '123456'): PromiseInterface
     {
         return (new Browser($this->loop))
             ->request(
                 $method,
-                "http://{$host}:{$port}/apps/{$appId}/{$path}",
+                "http://{$host}:{$port}{$pathPrefix}/apps/{$appId}/{$path}",
                 [],
                 ($data) ? json_encode($data) : ''
             );
@@ -160,7 +160,7 @@ public function requestWithoutAppId(string $path, string $method = 'GET', mixed
     /**
      * Send a signed request to the server.
      */
-    public function signedRequest(string $path, string $method = 'GET', mixed $data = '', string $host = '0.0.0.0', string $port = '8080', string $appId = '123456', string $key = 'reverb-key', string $secret = 'reverb-secret'): PromiseInterface
+    public function signedRequest(string $path, string $method = 'GET', mixed $data = '', string $host = '0.0.0.0', string $port = '8080', string $pathPrefix = '', string $appId = '123456', string $key = 'reverb-key', string $secret = 'reverb-secret'): PromiseInterface
     {
         $timestamp = time();
 
@@ -179,25 +179,25 @@ public function signedRequest(string $path, string $method = 'GET', mixed $data
             $query .= "&body_md5={$hash}";
         }
 
-        $string = "{$method}\n/apps/{$appId}/{$path}\n$query";
+        $string = "{$method}\n{$pathPrefix}/apps/{$appId}/{$path}\n$query";
         $signature = hash_hmac('sha256', $string, $secret);
 
-        return $this->request("{$path}?{$query}&auth_signature={$signature}", $method, $data, $host, $port, $appId);
+        return $this->request("{$path}?{$query}&auth_signature={$signature}", $method, $data, $host, $port, $pathPrefix, $appId);
     }
 
     /**
      * Send a POST request to the server.
      */
-    public function postRequest(string $path, ?array $data = [], string $host = '0.0.0.0', string $port = '8080', string $appId = '123456'): PromiseInterface
+    public function postRequest(string $path, ?array $data = [], string $host = '0.0.0.0', string $port = '8080', string $pathPrefix = '', string $appId = '123456'): PromiseInterface
     {
-        return $this->request($path, 'POST', $data, $host, $port, $appId);
+        return $this->request($path, 'POST', $data, $host, $port, $pathPrefix, $appId);
     }
 
     /**
      * Send a signed POST request to the server.
      */
-    public function signedPostRequest(string $path, ?array $data = [], string $host = '0.0.0.0', string $port = '8080', string $appId = '123456', $key = 'reverb-key', $secret = 'reverb-secret'): PromiseInterface
+    public function signedPostRequest(string $path, ?array $data = [], string $host = '0.0.0.0', string $port = '8080', string $pathPrefix = '', string $appId = '123456', $key = 'reverb-key', $secret = 'reverb-secret'): PromiseInterface
     {
-        return $this->signedRequest($path, 'POST', $data, $host, $port, $appId, $key, $secret);
+        return $this->signedRequest($path, 'POST', $data, $host, $port, $pathPrefix, $appId, $key, $secret);
     }
 }