Merge branch '2.x' into redis-replication

.github/workflows/run-tests.yml

@@ -37,7 +37,7 @@ jobs:
                 with:
                     php-version: ${{ matrix.php }}
                     extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
-                    coverage: none
+                    coverage: pcov
 
             -   name: Install dependencies
                 run: |
@@ -45,4 +45,8 @@ jobs:
                     composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
 
             -   name: Execute tests
-                run: vendor/bin/phpunit
+                run: vendor/bin/phpunit --coverage-text --coverage-clover=coverage.xml
+
+            -   uses: codecov/codecov-action@v1
+                with:
+                    fail_ci_if_error: false

config/websockets.php

@@ -1,26 +1,79 @@
 <?php
 
-use BeyondCode\LaravelWebSockets\Dashboard\Http\Middleware\Authorize;
-
 return [
 
     /*
-     * Set a custom dashboard configuration
+    |--------------------------------------------------------------------------
-     */
+    | Dashboard Settings
+    |--------------------------------------------------------------------------
+    |
+    | You can configure the dashboard settings from here.
+    |
+    */
+
     'dashboard' => [
+
         'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
+
+        'path' => 'laravel-websockets',
+
+        'middleware' => [
+            'web',
+            \BeyondCode\LaravelWebSockets\Dashboard\Http\Middleware\Authorize::class,
+        ],
+
+    ],
+
+    'managers' => [
+
+        /*
+        |--------------------------------------------------------------------------
+        | Application Manager
+        |--------------------------------------------------------------------------
+        |
+        | An Application manager determines how your websocket server allows
+        | the use of the TCP protocol based on, for example, a list of allowed
+        | applications.
+        | By default, it uses the defined array in the config file, but you can
+        | anytime implement the same interface as the class and add your own
+        | custom method to retrieve the apps.
+        |
+        */
+
+        'app' => \BeyondCode\LaravelWebSockets\Apps\ConfigAppProvider::class,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Channel Manager
+        |--------------------------------------------------------------------------
+        |
+        | When users subscribe or unsubscribe from specific channels,
+        | the connections are stored to keep track of any interaction with the
+        | WebSocket server.
+        | You can however add your own implementation that will help the store
+        | of the channels alongside their connections.
+        |
+        */
+
+        'channel' => \BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManagers\ArrayChannelManager::class,
+
     ],
 
     /*
-     * This package comes with multi tenancy out of the box. Here you can
+    |--------------------------------------------------------------------------
-     * configure the different apps that can use the webSockets server.
+    | Applications Repository
-     *
+    |--------------------------------------------------------------------------
-     * Optionally you specify capacity so you can limit the maximum
+    |
-     * concurrent connections for a specific app.
+    | By default, the only allowed app is the one you define with
-     *
+    | your PUSHER_* variables from .env.
-     * Optionally you can disable client events so clients cannot send
+    | You can configure to use multiple apps if you need to, or use
-     * messages to each other via the webSockets.
+    | a custom App Manager that will handle the apps from a database, per se.
-     */
+    |
+    | You can apply multiple settings, like the maximum capacity, enable
+    | client-to-client messages or statistics.
+    |
+    */
+
     'apps' => [
         [
             'id' => env('PUSHER_APP_ID'),
@@ -35,114 +88,172 @@ return [
     ],
 
     /*
-     * This class is responsible for finding the apps. The default provider
+    |--------------------------------------------------------------------------
-     * will use the apps defined in this config file.
+    | Allowed Origins
-     *
+    |--------------------------------------------------------------------------
-     * You can create a custom provider by implementing the
+    |
-     * `AppProvider` interface.
+    | If not empty, you can whitelist certain origins that will be allowed
-     */
+    | to connect to the websocket server.
-    'app_provider' => BeyondCode\LaravelWebSockets\Apps\ConfigAppProvider::class,
+    |
+    */
 
-    /*
-     * This array contains the hosts of which you want to allow incoming requests.
-     * Leave this empty if you want to accept requests from all hosts.
-     */
     'allowed_origins' => [
         //
     ],
 
     /*
-     * The maximum request size in kilobytes that is allowed for an incoming WebSocket request.
+    |--------------------------------------------------------------------------
-     */
+    | Maximum Request Size
+    |--------------------------------------------------------------------------
+    |
+    | The maximum request size in kilobytes that is allowed for
+    | an incoming WebSocket request.
+    |
+    */
+
     'max_request_size_in_kb' => 250,
 
     /*
-     * This path will be used to register the necessary routes for the package.
+    |--------------------------------------------------------------------------
-     */
+    | SSL Configuration
-    'path' => 'laravel-websockets',
+    |--------------------------------------------------------------------------
+    |
+    | By default, the configuration allows only on HTTP. For SSL, you need
+    | to set up the the certificate, the key, and optionally, the passphrase
+    | for the private key.
+    | You will need to restart the server for the settings to take place.
+    |
+    */
 
-    /*
-     * Dashboard Routes Middleware
-     *
-     * These middleware will be assigned to every dashboard route, giving you
-     * the chance to add your own middleware to this list or change any of
-     * the existing middleware. Or, you can simply stick with this list.
-     */
-    'middleware' => [
-        'web',
-        Authorize::class,
-    ],
-
-    'statistics' => [
-        /*
-         * This model will be used to store the statistics of the WebSocketsServer.
-         * The only requirement is that the model should extend
-         * `WebSocketsStatisticsEntry` provided by this package.
-         */
-        'model' => \BeyondCode\LaravelWebSockets\Statistics\Models\WebSocketsStatisticsEntry::class,
-
-        /*
-         * Here you can specify the interval in seconds at which statistics should be logged.
-         */
-        'interval_in_seconds' => 60,
-
-        /*
-         * When the clean-command is executed, all recorded statistics older than
-         * the number of days specified here will be deleted.
-         */
-        'delete_statistics_older_than_days' => 60,
-
-        /*
-         * Use an DNS resolver to make the requests to the statistics logger
-         * default is to resolve everything to 127.0.0.1.
-         */
-        'perform_dns_lookup' => false,
-    ],
-
-    /*
-     * Define the optional SSL context for your WebSocket connections.
-     * You can see all available options at: http://php.net/manual/en/context.ssl.php
-     */
     'ssl' => [
-        /*
+
-         * Path to local certificate file on filesystem. It must be a PEM encoded file which
-         * contains your certificate and private key. It can optionally contain the
-         * certificate chain of issuers. The private key also may be contained
-         * in a separate file specified by local_pk.
-         */
         'local_cert' => env('LARAVEL_WEBSOCKETS_SSL_LOCAL_CERT', null),
 
-        /*
+        'capath' => env('LARAVEL_WEBSOCKETS_SSL_CA', null),
-         * Path to local private key file on filesystem in case of separate files for
+
-         * certificate (local_cert) and private key.
-         */
         'local_pk' => env('LARAVEL_WEBSOCKETS_SSL_LOCAL_PK', null),
 
-        /*
-         * Passphrase for your local_cert file.
-         */
         'passphrase' => env('LARAVEL_WEBSOCKETS_SSL_PASSPHRASE', null),
+
+        'verify_peer' => env('APP_ENV') === 'production',
+
+        'allow_self_signed' => env('APP_ENV') !== 'production',
+
     ],
   
     /*
      * You can enable replication to publish and subscribe to messages across the driver
      */
+    /*
+    |--------------------------------------------------------------------------
+    | Broadcasting Replication
+    |--------------------------------------------------------------------------
+    |
+    | You can enable replication to publish and subscribe to
+    | messages across the driver.
+    |
+    | By default, it is disabled, but you can configure it to use drivers
+    | like Redis to ensure connection between multiple instances of
+    | WebSocket servers.
+    |
+    */
     'replication' => [
+
         'enabled' => false,
 
         'driver' => 'redis',
 
         'redis' => [
+
             'connection' => 'default',
+
         ],
+
+    ],
+
+    'statistics' => [
+
+        /*
+        |--------------------------------------------------------------------------
+        | Statistics Eloquent Model
+        |--------------------------------------------------------------------------
+        |
+        | This model will be used to store the statistics of the WebSocketsServer.
+        | The only requirement is that the model should extend
+        | `WebSocketsStatisticsEntry` provided by this package.
+        |
+        */
+
+        'model' => \BeyondCode\LaravelWebSockets\Statistics\Models\WebSocketsStatisticsEntry::class,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Statistics Logger Handler
+        |--------------------------------------------------------------------------
+        |
+        | The Statistics Logger will, by default, handle the incoming statistics,
+        | store them into an array and then store them into the database
+        | on each interval.
+        |
+        */
+
+        'logger' => \BeyondCode\LaravelWebSockets\Statistics\Logger::class,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Statistics Interval Period
+        |--------------------------------------------------------------------------
+        |
+        | Here you can specify the interval in seconds at which
+        | statistics should be logged.
+        |
+        */
+
+        'interval_in_seconds' => 60,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Statistics Deletion Period
+        |--------------------------------------------------------------------------
+        |
+        | When the clean-command is executed, all recorded statistics older than
+        | the number of days specified here will be deleted.
+        |
+        */
+
+        'delete_statistics_older_than_days' => 60,
+
+        /*
+        |--------------------------------------------------------------------------
+        | DNS Lookup
+        |--------------------------------------------------------------------------
+        |
+        | Use an DNS resolver to make the requests to the statistics logger
+        | default is to resolve everything to 127.0.0.1.
+        |
+        */
+
+        'perform_dns_lookup' => false,
+
+        /*
+        |--------------------------------------------------------------------------
+        | DNS Lookup TLS Settings
+        |--------------------------------------------------------------------------
+        |
+        | You can configure the DNS Lookup Connector the TLS settings.
+        | Check the available options here:
+        | https://github.com/reactphp/socket/blob/master/src/Connector.php#L29
+        |
+        */
+
+        'tls' => [
+
+            'verify_peer' => env('APP_ENV') === 'production',
+
+            'verify_peer_name' => env('APP_ENV') === 'production',
+
+        ],
+
     ],
 
-    /*
-     * Channel Manager
-     * This class handles how channel persistence is handled.
-     * By default, persistence is stored in an array by the running webserver.
-     * The only requirement is that the class should implement
-     * `ChannelManager` interface provided by this package.
-     */
-    'channel_manager' => \BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManagers\ArrayChannelManager::class,
 ];

resources/views/dashboard.blade.php

@@ -118,7 +118,7 @@
                     wssPort: this.port === null ? 6001 : this.port,
                     wsPath: this.app.path === null ? '' : this.app.path,
                     disableStats: true,
-                    authEndpoint: '/{{ request()->path() }}/auth',
+                    authEndpoint: '{{ url('/auth') }}',
                     auth: {
                         headers: {
                             'X-CSRF-Token': "{{ csrf_token() }}",
@@ -162,7 +162,7 @@
             },
 
             loadChart() {
-                $.getJSON('/{{ request()->path() }}/api/'+this.app.id+'/statistics', (data) => {
+                $.getJSON('{{ url('/api') }}/' + this.app.id + '/statistics', (data) => {
 
                     let chartData = [
                         {
@@ -246,7 +246,7 @@
             },
 
             sendEvent() {
-                $.post('/{{ request()->path() }}/event', {
+                $.post('{{ url('/event') }}', {
                     _token: '{{ csrf_token() }}',
                     key: this.app.key,
                     secret: this.app.secret,

src/Console/RestartWebSocketServer.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace BeyondCode\LaravelWebSockets\Console;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\InteractsWithTime;
+
+class RestartWebSocketServer extends Command
+{
+    use InteractsWithTime;
+
+    protected $signature = 'websockets:restart';
+
+    protected $description = 'Restart the Laravel WebSocket Server';
+
+    public function handle()
+    {
+        Cache::forever('beyondcode:websockets:restart', $this->currentTime());
+
+        $this->info('Broadcasting WebSocket server restart signal.');
+    }
+}

src/Console/StartWebSocketServer.php

@@ -10,11 +10,11 @@ use BeyondCode\LaravelWebSockets\Server\Logger\HttpLogger;
 use BeyondCode\LaravelWebSockets\Server\Logger\WebsocketsLogger;
 use BeyondCode\LaravelWebSockets\Server\WebSocketServerFactory;
 use BeyondCode\LaravelWebSockets\Statistics\DnsResolver;
-use BeyondCode\LaravelWebSockets\Statistics\Logger\HttpStatisticsLogger;
 use BeyondCode\LaravelWebSockets\Statistics\Logger\StatisticsLogger as StatisticsLoggerInterface;
 use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManager;
 use Clue\React\Buzz\Browser;
 use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Cache;
 use React\Dns\Config\Config as DnsConfig;
 use React\Dns\Resolver\Factory as DnsFactory;
 use React\Dns\Resolver\ResolverInterface;
@@ -30,6 +30,9 @@ class StartWebSocketServer extends Command
     /** @var \React\EventLoop\LoopInterface */
     protected $loop;
 
+    /** @var int */
+    protected $lastRestart;
+
     public function __construct()
     {
         parent::__construct();
@@ -44,6 +47,7 @@ class StartWebSocketServer extends Command
             ->configureHttpLogger()
             ->configureMessageLogger()
             ->configureConnectionLogger()
+            ->configureRestartTimer()
             ->registerEchoRoutes()
             ->registerCustomRoutes()
             ->configurePubSubReplication()
@@ -54,16 +58,15 @@ class StartWebSocketServer extends Command
     {
         $connector = new Connector($this->loop, [
             'dns' => $this->getDnsResolver(),
-            'tls' => [
+            'tls' => config('websockets.statistics.tls'),
-                'verify_peer' => config('app.env') === 'production',
-                'verify_peer_name' => config('app.env') === 'production',
-            ],
         ]);
 
         $browser = new Browser($this->loop, $connector);
 
         $this->laravel->singleton(StatisticsLoggerInterface::class, function () use ($browser) {
-            return new HttpStatisticsLogger($this->laravel->make(ChannelManager::class), $browser);
+            $class = config('websockets.statistics.logger', \BeyondCode\LaravelWebSockets\Statistics\Logger::class);
+
+            return new $class(app(ChannelManager::class), $browser);
         });
 
         $this->loop->addPeriodicTimer(config('websockets.statistics.interval_in_seconds'), function () {
@@ -106,6 +109,19 @@ class StartWebSocketServer extends Command
         return $this;
     }
 
+    public function configureRestartTimer()
+    {
+        $this->lastRestart = $this->getLastRestart();
+
+        $this->loop->addPeriodicTimer(10, function () {
+            if ($this->getLastRestart() !== $this->lastRestart) {
+                $this->loop->stop();
+            }
+        });
+
+        return $this;
+    }
+
     protected function registerEchoRoutes()
     {
         WebSocketsRouter::echo();
@@ -159,4 +175,9 @@ class StartWebSocketServer extends Command
             $this->loop
         );
     }
+
+    protected function getLastRestart()
+    {
+        return Cache::get('beyondcode:websockets:restart', 0);
+    }
 }

src/WebSocketsServiceProvider.php

@@ -48,6 +48,7 @@ class WebSocketsServiceProvider extends ServiceProvider
         $this->commands([
             Console\StartWebSocketServer::class,
             Console\CleanStatistics::class,
+            Console\RestartWebSocketServer::class,
         ]);
 
         $this->configurePubSub();
@@ -95,19 +96,20 @@ class WebSocketsServiceProvider extends ServiceProvider
         });
 
         $this->app->singleton(ChannelManager::class, function () {
-            return config('websockets.channel_manager') !== null && class_exists(config('websockets.channel_manager'))
+            $channelManager = config('websockets.managers.channel', ArrayChannelManager::class);
-                ? $this->app->make(config('websockets.channel_manager')) : new ArrayChannelManager();
+
+            return new $channelManager;
         });
 
         $this->app->singleton(AppProvider::class, function () {
-            return $this->app->make(config('websockets.app_provider'));
+            return $this->app->make(config('websockets.managers.app'));
         });
     }
 
     protected function registerRoutes()
     {
-        Route::prefix(config('websockets.path'))->group(function () {
+        Route::prefix(config('websockets.dashboard.path'))->group(function () {
-            Route::middleware(config('websockets.middleware', [AuthorizeDashboard::class]))->group(function () {
+            Route::middleware(config('websockets.dashboard.middleware', [AuthorizeDashboard::class]))->group(function () {
                 Route::get('/', ShowDashboard::class);
                 Route::get('/api/{appId}/statistics', [DashboardApiController::class, 'getStatistics']);
                 Route::post('auth', AuthenticateDashboard::class);

tests/Commands/RestartWebSocketServerTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace BeyondCode\LaravelWebSockets\Tests\Commands;
+
+use Artisan;
+use BeyondCode\LaravelWebSockets\Tests\TestCase;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\InteractsWithTime;
+
+class RestartWebSocketServerTest extends TestCase
+{
+    use InteractsWithTime;
+
+    /** @test */
+    public function it_can_broadcast_restart_signal()
+    {
+        $start = $this->currentTime();
+
+        Artisan::call('websockets:restart');
+
+        $this->assertGreaterThanOrEqual($start, Cache::get('beyondcode:websockets:restart', 0));
+    }
+}