BeyondCode\LaravelWebSockets\Console\StartWebSocketServer

Complexity

Total Complexity

17

Size/Duplication

Total Lines	252
Duplicated Lines	11.9 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	handle()	0	12	1
A	configureStatisticsLogger()	0	19	2
A	configureHttpLogger()	10	10	2
A	configureMessageLogger()	10	10	2
A	configureConnectionLogger()	10	10	1
A	configureRestartTimer()	0	12	2
A	configurePubSub()	0	19	1
A	registerRoutes()	0	6	1
A	startWebSocketServer()	0	17	2
A	buildServer()	0	12	1
A	getLastRestart()	0	4	1

<?php

namespace BeyondCode\LaravelWebSockets\Console;

use BeyondCode\LaravelWebSockets\Facades\StatisticsLogger;
use BeyondCode\LaravelWebSockets\Facades\WebSocketsRouter;
use BeyondCode\LaravelWebSockets\PubSub\ReplicationInterface;
use BeyondCode\LaravelWebSockets\Server\Logger\ConnectionLogger;
use BeyondCode\LaravelWebSockets\Server\Logger\HttpLogger;
use BeyondCode\LaravelWebSockets\Server\Logger\WebsocketsLogger;
use BeyondCode\LaravelWebSockets\Server\WebSocketServerFactory;
use BeyondCode\LaravelWebSockets\Statistics\Drivers\StatisticsDriver;
use BeyondCode\LaravelWebSockets\Statistics\Logger\StatisticsLogger as StatisticsLoggerInterface;
use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManager;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Cache;
use React\EventLoop\Factory as LoopFactory;

class StartWebSocketServer extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'websockets:serve
        {--host=0.0.0.0}
        {--port=6001}
        {--statistics-interval= : Overwrite the statistics interval set in the config.}
        {--debug : Forces the loggers to be enabled and thereby overriding the APP_DEBUG setting.}
        {--test : Prepare the server, but do not start it.}
    ';

    /**
     * The console command description.
     *
     * @var string|null
     */
    protected $description = 'Start the Laravel WebSocket Server';

    /**
     * Get the loop instance.
     *
     * @var \React\EventLoop\LoopInterface
     */
    protected $loop;

    /**
     * The Pusher server instance.
     *
     * @var \Ratchet\Server\IoServer
     */
    public $server;

    /**
     * Track the last restart.
     *
     * @var int
     */
    protected $lastRestart;

    /**
     * Initialize the command.
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        parent::__construct();

        $this->loop = LoopFactory::create();
    }

    /**
     * Run the command.
     *
     * @return void
     */
    public function handle()
    {
        $this
            ->configureStatisticsLogger()
            ->configureHttpLogger()
            ->configureMessageLogger()
            ->configureConnectionLogger()
            ->configureRestartTimer()
            ->configurePubSub()
            ->registerRoutes()
            ->startWebSocketServer();
    }

    /**
     * Configure the statistics logger class.
     *
     * @return $this
     */
    protected function configureStatisticsLogger()
    {
        $this->laravel->singleton(StatisticsLoggerInterface::class, function () {
            $class = config('websockets.statistics.logger', \BeyondCode\LaravelWebSockets\Statistics\Logger\MemoryStatisticsLogger::class);

            return new $class(
                $this->laravel->make(ChannelManager::class),
                $this->laravel->make(StatisticsDriver::class)
            );
        });

        $this->loop->addPeriodicTimer($this->option('statistics-interval') ?: config('websockets.statistics.interval_in_seconds'), function () {
            $this->line('Saving statistics...');

            StatisticsLogger::save();
        });

        return $this;
    }

    /**
     * Configure the HTTP logger class.
     *
     * @return $this
     */
    protected function configureHttpLogger()

This method seems to be duplicated in your project.

    {
        $this->laravel->singleton(HttpLogger::class, function () {
            return (new HttpLogger($this->output))
                ->enable($this->option('debug') ?: config('app.debug'))
                ->verbose($this->output->isVerbose());
        });

        return $this;
    }

    /**
     * Configure the logger for messages.
     *
     * @return $this
     */
    protected function configureMessageLogger()

This method seems to be duplicated in your project.

    {
        $this->laravel->singleton(WebsocketsLogger::class, function () {
            return (new WebsocketsLogger($this->output))
                ->enable($this->option('debug') ?: config('app.debug'))
                ->verbose($this->output->isVerbose());
        });

        return $this;
    }

    /**
     * Configure the connection logger.
     *
     * @return $this
     */
    protected function configureConnectionLogger()

This method seems to be duplicated in your project.

    {
        $this->laravel->bind(ConnectionLogger::class, function () {
            return (new ConnectionLogger($this->output))
                ->enable(config('app.debug'))
                ->verbose($this->output->isVerbose());
        });

        return $this;
    }

    /**
     * Configure the Redis PubSub handler.
     *
     * @return $this
     */
    public function configureRestartTimer()
    {
        $this->lastRestart = $this->getLastRestart();

        $this->loop->addPeriodicTimer(10, function () {
            if ($this->getLastRestart() !== $this->lastRestart) {
                $this->loop->stop();
            }
        });

        return $this;
    }

    /**
     * Configure the replicators.
     *
     * @return void
     */
    public function configurePubSub()
    {
        $this->laravel->singleton(ReplicationInterface::class, function () {
            $driver = config('websockets.replication.driver', 'local');

            $client = config(
                "websockets.replication.{$driver}.client",
                \BeyondCode\LaravelWebSockets\PubSub\Drivers\LocalClient::class
            );

            return (new $client)->boot($this->loop);
        });

        $this->laravel
            ->get(ReplicationInterface::class)
            ->boot($this->loop);

        return $this;
    }

    /**
     * Register the routes.
     *
     * @return $this
     */
    protected function registerRoutes()
    {
        WebSocketsRouter::routes();

        return $this;
    }

    /**
     * Start the server.
     *
     * @return void
     */
    protected function startWebSocketServer()
    {
        $this->info("Starting the WebSocket server on port {$this->option('port')}...");

        $this->buildServer();

        // For testing, just boot up the server, run it
        // but exit after the next tick.
        if ($this->option('test')) {
            $this->loop->futureTick(function () {
                $this->loop->stop();
            });
        }

        /* 🛰 Start the server 🛰  */
        $this->server->run();
    }

    /**
     * Build the server instance.
     *
     * @return void
     */
    protected function buildServer()
    {
        $this->server = new WebSocketServerFactory(

It seems like new \BeyondCode\LaravelWebSockets\Server\WebSocketServerFactory($this->option('host'), $this->option('port')) of type object<BeyondCode\LaravelWebSockets\Server\WebSocketServerFactory> is incompatible with the declared type object<Ratchet\Server\IoServer> of property $server.

            $this->option('host'), $this->option('port')
        );

        $this->server = $this->server
            ->setLoop($this->loop)
            ->useRoutes(WebSocketsRouter::getRoutes())
            ->setConsoleOutput($this->output)
            ->createServer();
    }

    /**
     * Get the last time the server restarted.
     *
     * @return int
     */
    protected function getLastRestart()
    {
        return Cache::get('beyondcode:websockets:restart', 0);
    }
}