HorizonServiceProvider::shouldRebindHorizonRedisFactory() - Code Metrics - Inspection of "Add support for Horizon" - monospice/laravel-redis-sentinel-drivers - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — integration-tests ( aca6ec )

by Cy

created 2018-03-22 22:25 UTC

shouldRebindHorizonRedisFactory() A

↳ Parent: HorizonServiceProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	0

<?php

namespace Monospice\LaravelRedisSentinel\Horizon;

use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Redis\Factory as RedisFactory;
use Illuminate\Support\Arr;
use Illuminate\Support\ServiceProvider;
use Laravel\Horizon\Connectors\RedisConnector as HorizonRedisConnector;
use Monospice\LaravelRedisSentinel\Configuration\Loader as ConfigurationLoader;
use Monospice\LaravelRedisSentinel\Horizon\HorizonServiceBindings;
use Monospice\LaravelRedisSentinel\RedisSentinelManager;
use RuntimeException;

/**
 * Configures the application to use Redis Sentinel connections for Laravel
 * Horizon.
 *
 * @category Package
 * @package  Monospice\LaravelRedisSentinel
 * @author   Cy Rossignol <[email protected]>
 * @license  See LICENSE file
 * @link     https://github.com/monospice/laravel-redis-sentinel-drivers
 */
class HorizonServiceProvider extends ServiceProvider
{
    /**
     * Loads the package's configuration and provides configuration values.
     *
     * @var ConfigurationLoader
     */
    protected $config;

    /**
     * Create a new service provider instance.
     *
     * @param Container           $app    The current Laravel/Lumen application
     * instance.
     * @param ConfigurationLoader $config Loads the package's configuration and

     * provides configuration values.
     */
    public function __construct(
        Container $app,
        ConfigurationLoader $config = null
    ) {
        parent::__construct($app);


        if ($config === null) {
            $config = ConfigurationLoader::load($app);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        $this->config = $config;
    }

    /**
     * Configure the package for use with Laravel Horizon.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton('redis-sentinel', function ($app) {

            $this->createHorizonConnectionConfiguration();

            $class = $this->config->getVersionedRedisSentinelManagerClass();
            $config = $this->config->get('database.redis-sentinel', [ ]);
            $driver = Arr::pull($config, 'client', 'predis');

            return new RedisSentinelManager(new $class($driver, $config));
        });

        if ($this->shouldRebindHorizonRedisFactory()) {
            $this->rebindHorizonRedisFactory();
        }

        $this->addHorizonSentinelQueueConnector();
    }

    /**
     * Sets the Horizon Redis Sentinel connection configuration.
     *
     * @return void
     */
    protected function createHorizonConnectionConfiguration()
    {
        $horizonConfig = $this->getSelectedConnectionConfiguration();
        $options = Arr::get($horizonConfig, 'options', [ ]);
        $options['prefix'] = $this->config->get('horizon.prefix', 'horizon:');

        $horizonConfig['options'] = $options;

        $this->config->set('database.redis-sentinel.horizon', $horizonConfig);
    }

    /**
     * Copy the Redis Sentinel connection configuration to use for Horizon
     * connections from the connection specified by "horizon.use".
     *
     * @return array The configuration matching the connection name specified
     * by the "horizon.use" config directive.
     *
     * @throws RuntimeException If no Redis Sentinel connection matches the
     * name declared by "horizon.use".
     */
    protected function getSelectedConnectionConfiguration()
    {
        $use = $this->config->get('horizon.use', 'default');
        $connectionConfig = $this->config->get("database.redis-sentinel.$use");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);

        if ($connectionConfig === null) {
            throw new RuntimeException(
                "The Redis Sentinel connection [$use] is not defined."
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            );
        }

        return $connectionConfig;
    }

    /**
     * Determine whether the package needs to override the Redis service
     * injected into Horizon classes with the Sentinel service.
     *
     * @return bool True if configured as such and the package doesn't already
     * override the application's Redis API.
     */
    protected function shouldRebindHorizonRedisFactory()
    {
        // If we're already overriding Laravel's standard Redis API, we don't
        // need to rebind the "redis" service for Horizon.
        return ! $this->config->shouldOverrideLaravelRedisApi
            && $this->config->get('horizon.driver') === 'redis-sentinel';
    }

    /**
     * Add contextual bindings for Horizon's services that inject the package's
     * Redis Sentinel manager.
     *
     * @return void
     */
    protected function rebindHorizonRedisFactory()
    {
        // Although not all of the classes that Horizon registers need an
        // instance of the Redis service, we'll set up contextual bindings
        // for any declared so we don't need to update this package in the
        // future every time Horizon adds or removes one:
        foreach ((new HorizonServiceBindings()) as $serviceClass) {
            $this->app->when($serviceClass)
                ->needs(RedisFactory::class)
                ->give(function () {
                    return $this->app->make('redis-sentinel.manager');
                });
        }
    }

    /**
     * Add "redis-sentinel" as an available queue connection driver option to
     * the Laravel queue manager using Horizon's modified Redis connector.
     *
     * @return void
     */
    protected function addHorizonSentinelQueueConnector()

    {
        $this->app->make('queue')->extend('redis-sentinel', function () {
            $redis = $this->app->make('redis-sentinel.manager');

            return new HorizonRedisConnector($redis);
        });
    }
}


1		<?php
2
3		namespace Monospice\LaravelRedisSentinel\Horizon;
4
5		use Illuminate\Contracts\Container\Container;
6		use Illuminate\Contracts\Redis\Factory as RedisFactory;
7		use Illuminate\Support\Arr;
8		use Illuminate\Support\ServiceProvider;
9		use Laravel\Horizon\Connectors\RedisConnector as HorizonRedisConnector;
10		use Monospice\LaravelRedisSentinel\Configuration\Loader as ConfigurationLoader;
11		use Monospice\LaravelRedisSentinel\Horizon\HorizonServiceBindings;
12		use Monospice\LaravelRedisSentinel\RedisSentinelManager;
13		use RuntimeException;
14
15		/**
16		* Configures the application to use Redis Sentinel connections for Laravel
17		* Horizon.
18		*
19		* @category Package
20		* @package Monospice\LaravelRedisSentinel
21		* @author Cy Rossignol <[email protected]>
22		* @license See LICENSE file
23		* @link https://github.com/monospice/laravel-redis-sentinel-drivers
24		*/
25		class HorizonServiceProvider extends ServiceProvider
26		{
27		/**
28		* Loads the package's configuration and provides configuration values.
29		*
30		* @var ConfigurationLoader
31		*/
32		protected $config;
33
34		/**
35		* Create a new service provider instance.
36		*
37		* @param Container $app The current Laravel/Lumen application
38		* instance.
39		* @param ConfigurationLoader $config Loads the package's configuration and
		0 ignored issues – show Documentation introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report Should the type for parameter `$config` not be `null\|ConfigurationLoader`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
40		* provides configuration values.
41		*/
42		public function __construct(
43		Container $app,
44		ConfigurationLoader $config = null
45		) {
46		parent::__construct($app);
		0 ignored issues – show Compatibility introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report `$app` of type `object<Illuminate\Contracts\Container\Container>` is not a sub-type of `object<Illuminate\Contra...Foundation\Application>`. It seems like you assume a child interface of the interface `Illuminate\Contracts\Container\Container` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
47
48		if ($config === null) {
49		$config = ConfigurationLoader::load($app);
		0 ignored issues – show Documentation introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report `$app` is of type `object<Illuminate\Contracts\Container\Container>`, but the function expects a `object<Illuminate\Founda...avel\Lumen\Application>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
50		}
51
52		$this->config = $config;
53		}
54
55		/**
56		* Configure the package for use with Laravel Horizon.
57		*
58		* @return void
59		*/
60		public function register()
61		{
62	View Code Duplication	$this->app->singleton('redis-sentinel', function ($app) {
		0 ignored issues – show Unused Code introduced 2018-03-20 02:38 UTC by Report Bug Copy Issue Report The parameter `$app` 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... Duplication introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
63		$this->createHorizonConnectionConfiguration();
64
65		$class = $this->config->getVersionedRedisSentinelManagerClass();
66		$config = $this->config->get('database.redis-sentinel', [ ]);
67		$driver = Arr::pull($config, 'client', 'predis');
68
69		return new RedisSentinelManager(new $class($driver, $config));
70		});
71
72		if ($this->shouldRebindHorizonRedisFactory()) {
73		$this->rebindHorizonRedisFactory();
74		}
75
76		$this->addHorizonSentinelQueueConnector();
77		}
78
79		/**
80		* Sets the Horizon Redis Sentinel connection configuration.
81		*
82		* @return void
83		*/
84		protected function createHorizonConnectionConfiguration()
85		{
86		$horizonConfig = $this->getSelectedConnectionConfiguration();
87		$options = Arr::get($horizonConfig, 'options', [ ]);
88		$options['prefix'] = $this->config->get('horizon.prefix', 'horizon:');
89
90		$horizonConfig['options'] = $options;
91
92		$this->config->set('database.redis-sentinel.horizon', $horizonConfig);
93		}
94
95		/**
96		* Copy the Redis Sentinel connection configuration to use for Horizon
97		* connections from the connection specified by "horizon.use".
98		*
99		* @return array The configuration matching the connection name specified
100		* by the "horizon.use" config directive.
101		*
102		* @throws RuntimeException If no Redis Sentinel connection matches the
103		* name declared by "horizon.use".
104		*/
105		protected function getSelectedConnectionConfiguration()
106		{
107		$use = $this->config->get('horizon.use', 'default');
108		$connectionConfig = $this->config->get("database.redis-sentinel.$use");
		0 ignored issues – show Coding Style Best Practice introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$use` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
109
110		if ($connectionConfig === null) {
111		throw new RuntimeException(
112		"The Redis Sentinel connection [$use] is not defined."
		0 ignored issues – show Coding Style Best Practice introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$use` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
113		);
114		}
115
116		return $connectionConfig;
117		}
118
119		/**
120		* Determine whether the package needs to override the Redis service
121		* injected into Horizon classes with the Sentinel service.
122		*
123		* @return bool True if configured as such and the package doesn't already
124		* override the application's Redis API.
125		*/
126		protected function shouldRebindHorizonRedisFactory()
127		{
128		// If we're already overriding Laravel's standard Redis API, we don't
129		// need to rebind the "redis" service for Horizon.
130		return ! $this->config->shouldOverrideLaravelRedisApi
131		&& $this->config->get('horizon.driver') === 'redis-sentinel';
132		}
133
134		/**
135		* Add contextual bindings for Horizon's services that inject the package's
136		* Redis Sentinel manager.
137		*
138		* @return void
139		*/
140		protected function rebindHorizonRedisFactory()
141		{
142		// Although not all of the classes that Horizon registers need an
143		// instance of the Redis service, we'll set up contextual bindings
144		// for any declared so we don't need to update this package in the
145		// future every time Horizon adds or removes one:
146		foreach ((new HorizonServiceBindings()) as $serviceClass) {
147		$this->app->when($serviceClass)
148		->needs(RedisFactory::class)
149		->give(function () {
150		return $this->app->make('redis-sentinel.manager');
151		});
152		}
153		}
154
155		/**
156		* Add "redis-sentinel" as an available queue connection driver option to
157		* the Laravel queue manager using Horizon's modified Redis connector.
158		*
159		* @return void
160		*/
161	View Code Duplication	protected function addHorizonSentinelQueueConnector()
		0 ignored issues – show Duplication introduced 2018-03-20 02:43 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
162		{
163		$this->app->make('queue')->extend('redis-sentinel', function () {
164		$redis = $this->app->make('redis-sentinel.manager');
165
166		return new HorizonRedisConnector($redis);
167		});
168		}
169		}
170

monospice / laravel-redis-sentinel-drivers

Push — integration-tests ( aca6ec )

shouldRebindHorizonRedisFactory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like