WebSocketsServiceProvider::configurePubSub() - Code Metrics - Inspection of "Redis as a replication backend for scalability" - beyondcode/laravel-websockets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#140)

by Alexandru

created 2020-08-13 07:20 UTC

WebSocketsServiceProvider::configurePubSub() A

↳ Parent: WebSocketsServiceProvider

Complexity

Conditions	4
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	9.408
c	0
b	0
f	0
cc	4
nc	2
nop	0

<?php

namespace BeyondCode\LaravelWebSockets;

use BeyondCode\LaravelWebSockets\Apps\AppProvider;
use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\AuthenticateDashboard;
use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\DashboardApiController;
use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\SendMessage;
use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\ShowDashboard;
use BeyondCode\LaravelWebSockets\Dashboard\Http\Middleware\Authorize as AuthorizeDashboard;
use BeyondCode\LaravelWebSockets\PubSub\Broadcasters\RedisPusherBroadcaster;
use BeyondCode\LaravelWebSockets\PubSub\Drivers\LocalClient;
use BeyondCode\LaravelWebSockets\PubSub\Drivers\RedisClient;
use BeyondCode\LaravelWebSockets\PubSub\ReplicationInterface;
use BeyondCode\LaravelWebSockets\Server\Router;
use BeyondCode\LaravelWebSockets\Statistics\Http\Controllers\WebSocketStatisticsEntriesController;
use BeyondCode\LaravelWebSockets\Statistics\Http\Middleware\Authorize as AuthorizeStatistics;
use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManager;
use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManagers\ArrayChannelManager;
use Pusher\Pusher;
use Psr\Log\LoggerInterface;
use Illuminate\Broadcasting\BroadcastManager;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Schema;

class WebSocketsServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->publishes([
            __DIR__.'/../config/websockets.php' => base_path('config/websockets.php'),
        ], 'config');

        if (! Schema::hasTable('websockets_statistics_entries')) {
            $this->publishes([
                __DIR__.'/../database/migrations/create_websockets_statistics_entries_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_websockets_statistics_entries_table.php'),
            ], 'migrations');
        }

        $this
            ->registerRoutes()
            ->registerDashboardGate();

        $this->loadViewsFrom(__DIR__.'/../resources/views/', 'websockets');

        $this->commands([
            Console\StartWebSocketServer::class,
            Console\CleanStatistics::class,
        ]);

        $this->configurePubSub();
    }

    protected function configurePubSub()
    {
        if (config('websockets.replication.enabled') !== true || config('websockets.replication.driver') !== 'redis') {
            $this->app->singleton(ReplicationInterface::class, function () {
                return new LocalClient();
            });

            return;
        }

        $this->app->singleton(ReplicationInterface::class, function () {
            return (new RedisClient())->boot($this->loop);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        });

        $this->app->get(BroadcastManager::class)->extend('redis-pusher', function ($app, array $config) {
            $pusher = new Pusher(
                $config['key'], $config['secret'],
                $config['app_id'], $config['options'] ?? []
            );

            if ($config['log'] ?? false) {
                $pusher->setLogger($this->app->make(LoggerInterface::class));
            }

            return new RedisPusherBroadcaster(
                $pusher,
                $config['app_id'],
                $this->app->make('redis'),
                $config['connection'] ?? null
            );
        });
    }

    public function register()
    {
        $this->mergeConfigFrom(__DIR__.'/../config/websockets.php', 'websockets');

        $this->app->singleton('websockets.router', function () {
            return new Router();
        });

        $this->app->singleton(ChannelManager::class, function () {
            return config('websockets.channel_manager') !== null && class_exists(config('websockets.channel_manager'))
                ? $this->app->make(config('websockets.channel_manager')) : new ArrayChannelManager();
        });

        $this->app->singleton(AppProvider::class, function () {
            return $this->app->make(config('websockets.app_provider'));
        });
    }

    protected function registerRoutes()
    {
        Route::prefix(config('websockets.path'))->group(function () {
            Route::middleware(config('websockets.middleware', [AuthorizeDashboard::class]))->group(function () {
                Route::get('/', ShowDashboard::class);
                Route::get('/api/{appId}/statistics', [DashboardApiController::class, 'getStatistics']);
                Route::post('auth', AuthenticateDashboard::class);
                Route::post('event', SendMessage::class);
            });

            Route::middleware(AuthorizeStatistics::class)->group(function () {
                Route::post('statistics', [WebSocketStatisticsEntriesController::class, 'store']);
            });
        });

        return $this;
    }

    protected function registerDashboardGate()
    {
        Gate::define('viewWebSocketsDashboard', function ($user = null) {

            return $this->app->environment('local');
        });

        return $this;
    }
}


1			<?php
2
3			namespace BeyondCode\LaravelWebSockets;
4
5			use BeyondCode\LaravelWebSockets\Apps\AppProvider;
6			use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\AuthenticateDashboard;
7			use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\DashboardApiController;
8			use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\SendMessage;
9			use BeyondCode\LaravelWebSockets\Dashboard\Http\Controllers\ShowDashboard;
10			use BeyondCode\LaravelWebSockets\Dashboard\Http\Middleware\Authorize as AuthorizeDashboard;
11			use BeyondCode\LaravelWebSockets\PubSub\Broadcasters\RedisPusherBroadcaster;
12			use BeyondCode\LaravelWebSockets\PubSub\Drivers\LocalClient;
13			use BeyondCode\LaravelWebSockets\PubSub\Drivers\RedisClient;
14			use BeyondCode\LaravelWebSockets\PubSub\ReplicationInterface;
15			use BeyondCode\LaravelWebSockets\Server\Router;
16			use BeyondCode\LaravelWebSockets\Statistics\Http\Controllers\WebSocketStatisticsEntriesController;
17			use BeyondCode\LaravelWebSockets\Statistics\Http\Middleware\Authorize as AuthorizeStatistics;
18			use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManager;
19			use BeyondCode\LaravelWebSockets\WebSockets\Channels\ChannelManagers\ArrayChannelManager;
20			use Pusher\Pusher;
21			use Psr\Log\LoggerInterface;
22			use Illuminate\Broadcasting\BroadcastManager;
23			use Illuminate\Support\Facades\Gate;
24			use Illuminate\Support\Facades\Route;
25			use Illuminate\Support\ServiceProvider;
26			use Illuminate\Support\Facades\Schema;
27
28			class WebSocketsServiceProvider extends ServiceProvider
29			{
30			public function boot()
31			{
32			$this->publishes([
33			__DIR__.'/../config/websockets.php' => base_path('config/websockets.php'),
34			], 'config');
35
36			if (! Schema::hasTable('websockets_statistics_entries')) {
37			$this->publishes([
38			__DIR__.'/../database/migrations/create_websockets_statistics_entries_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_websockets_statistics_entries_table.php'),
39			], 'migrations');
40			}
41
42			$this
43			->registerRoutes()
44			->registerDashboardGate();
45
46			$this->loadViewsFrom(__DIR__.'/../resources/views/', 'websockets');
47
48			$this->commands([
49			Console\StartWebSocketServer::class,
50			Console\CleanStatistics::class,
51			]);
52
53			$this->configurePubSub();
54			}
55
56			protected function configurePubSub()
57			{
58			if (config('websockets.replication.enabled') !== true \|\| config('websockets.replication.driver') !== 'redis') {
59			$this->app->singleton(ReplicationInterface::class, function () {
60			return new LocalClient();
61			});
62
63			return;
64			}
65
66			$this->app->singleton(ReplicationInterface::class, function () {
67			return (new RedisClient())->boot($this->loop);
			0 ignored issues – show Bug introduced 2019-09-03 15:52 UTC by Report Bug Copy Issue Report The property `loop` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
68			});
69
70			$this->app->get(BroadcastManager::class)->extend('redis-pusher', function ($app, array $config) {
71			$pusher = new Pusher(
72			$config['key'], $config['secret'],
73			$config['app_id'], $config['options'] ?? []
74			);
75
76			if ($config['log'] ?? false) {
77			$pusher->setLogger($this->app->make(LoggerInterface::class));
78			}
79
80			return new RedisPusherBroadcaster(
81			$pusher,
82			$config['app_id'],
83			$this->app->make('redis'),
84			$config['connection'] ?? null
85			);
86			});
87			}
88
89			public function register()
90			{
91			$this->mergeConfigFrom(__DIR__.'/../config/websockets.php', 'websockets');
92
93			$this->app->singleton('websockets.router', function () {
94			return new Router();
95			});
96
97			$this->app->singleton(ChannelManager::class, function () {
98			return config('websockets.channel_manager') !== null && class_exists(config('websockets.channel_manager'))
99			? $this->app->make(config('websockets.channel_manager')) : new ArrayChannelManager();
100			});
101
102			$this->app->singleton(AppProvider::class, function () {
103			return $this->app->make(config('websockets.app_provider'));
104			});
105			}
106
107			protected function registerRoutes()
108			{
109			Route::prefix(config('websockets.path'))->group(function () {
110			Route::middleware(config('websockets.middleware', [AuthorizeDashboard::class]))->group(function () {
111			Route::get('/', ShowDashboard::class);
112			Route::get('/api/{appId}/statistics', [DashboardApiController::class, 'getStatistics']);
113			Route::post('auth', AuthenticateDashboard::class);
114			Route::post('event', SendMessage::class);
115			});
116
117			Route::middleware(AuthorizeStatistics::class)->group(function () {
118			Route::post('statistics', [WebSocketStatisticsEntriesController::class, 'store']);
119			});
120			});
121
122			return $this;
123			}
124
125			protected function registerDashboardGate()
126			{
127			Gate::define('viewWebSocketsDashboard', function ($user = null) {
			0 ignored issues – show Unused Code introduced 2018-12-04 21:28 UTC by Report Bug Copy Issue Report The parameter `$user` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
128			return $this->app->environment('local');
129			});
130
131			return $this;
132			}
133			}
134

beyondcode / laravel-websockets

Pull Request — master (#140)

WebSocketsServiceProvider::configurePubSub() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like