CacheClientFactory::createRedisClient() - Code Metrics - Inspection of "- version bump" - kodedphp/cache-simple - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 5a87d9...5af04f )

by Mihail
created 2020-08-18 23:19 UTC
CacheClientFactory::createRedisClient() A

↳ Parent: CacheClientFactory
Complexity

Conditions	3
Paths	2
Size

Total Lines	18
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	13
CRAP Score	3
Importance

Changes
Metric	Value
cc	3
eloc	12
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	18
ccs	13
cts	13
cp	1
crap	3
rs	9.8666
<?php

/*
 * This file is part of the Koded package.
 *
 * (c) Mihail Binev <[email protected]>
 *
 * Please view the LICENSE distributed with this source code
 * for the full copyright and license information.
 *
 */

namespace Koded\Caching\Client;

use Error;
use Exception;
use Koded\Caching\{Cache, CacheException};
use Koded\Caching\Configuration\{MemcachedConfiguration, PredisConfiguration, RedisConfiguration};
use Koded\Stdlib\Interfaces\{Configuration, ConfigurationFactory, Serializer};
use Koded\Stdlib\Serializer\SerializerFactory;
use Psr\Log\{LoggerInterface, NullLogger};


final class CacheClientFactory
{
    const CACHE_CLIENT = 'CACHE_CLIENT';

    private $conf;

    public function __construct(ConfigurationFactory $conf)
    {
        $this->conf = $conf;
    }

    /**
     * Create an instance of specific cache client.
     *
     * @param string $client The required cache client
     *
     * @return Cache An instance of the cache client
     * @throws CacheException
     * @throws Exception
     */
    public function new(string $client = ''): Cache
    {
        $client = strtolower($client ?: getenv(self::CACHE_CLIENT) ?: 'memory');
        $config = $this->conf->build($client);

        switch ($client) {
            case 'memcached':
                /** @var MemcachedConfiguration $config */
                return $this->createMemcachedClient($config);

            case 'redis':
                /** @var RedisConfiguration $config */
                return $this->createRedisClient($config);

            case 'predis':
                /** @var PredisConfiguration $config */
                return $this->createPredisClient($config);

            case 'shmop':
                return new ShmopClient((string)$config->get('dir'), $config->get('ttl'));

            case 'file':
                return new FileClient($this->getLogger($config), (string)$config->get('dir'), $config->get('ttl'));

            case 'memory':
                return new MemoryClient($config->get('ttl'));
        }

        throw CacheException::forUnsupportedClient($client);
    }


    private function createRedisClient(RedisConfiguration $conf): Cache
    {
        $serializer = $conf->get('serializer');
        $binary = $conf->get('binary');

        if (Serializer::JSON === $serializer && $binary) {
            return new RedisJsonClient(
                $this->newRedis($conf),
                SerializerFactory::new((string)$binary, $conf->get('options')),
                (int)$conf->get('options'),
                $conf->get('ttl')
            );
        }

        return new RedisClient(
            $this->newRedis($conf),
            SerializerFactory::new($serializer, $conf->get('options')),
            $conf->get('ttl')
        );
    }


    private function createPredisClient(PredisConfiguration $conf): Cache
    {
        $serializer = $conf->get('serializer');
        $binary = $conf->get('binary');

        if (Serializer::JSON === $serializer && $binary) {
            return new PredisJsonClient(
                $this->newPredis($conf),
                SerializerFactory::new((string)$binary, $conf->get('options')),
                (int)$conf->get('options'),
                $conf->get('ttl')
            );
        }

        return new PredisClient(
            $this->newPredis($conf),
            SerializerFactory::new($conf->get('serializer'), $conf->get('options')),
            SerializerFactory::new(/** @scrutinizer ignore-type */ $conf->get('serializer'), $conf->get('options')),
            $conf->get('ttl')
        );
    }


    private function newRedis(RedisConfiguration $conf): \Redis
    {
        $client = new \Redis;

        try {
            @$client->connect(...$conf->getConnectionParams());
            /** @scrutinizer ignore-unhandled */ @$client->connect(...$conf->getConnectionParams());

            $client->setOption(\Redis::OPT_SERIALIZER, $conf->get('type'));
            $client->setOption(\Redis::OPT_PREFIX, $conf->get('prefix'));
            $client->select((int)$conf->get('db'));

            if ($auth = $conf->get('auth')) {
                $client->auth($auth);
            }

        } /** @noinspection PhpRedundantCatchClauseInspection */
        catch (\RedisException $e) {
            if (!strpos($e->getMessage(), ' AUTH ')) {
                error_log(sprintf(PHP_EOL . '[Redis] %s: %s', get_class($e), $e->getMessage()));
                error_log('[Redis] with conf: ' . $conf->toJSON());
                throw CacheException::withConnectionErrorFor('Redis');
            }
        } catch (Exception | Error $e) {
            throw CacheException::from($e);
        }

        return $client;
    }


    private function newPredis(PredisConfiguration $conf): \Predis\Client
    {
        $client = new \Predis\Client($conf->getConnectionParams(), $conf->getOptions());

        try {
            $client->connect();
            $client->select((int)$conf->get('db'));

            if ($auth = $conf->get('auth')) {
                $client->auth($auth);
            }

        } /** @noinspection PhpRedundantCatchClauseInspection */
        catch (\Predis\Connection\ConnectionException $e) {
            if (!strpos($e->getMessage(), ' AUTH ')) {
                error_log(sprintf(PHP_EOL . '[Predis] %s: %s', get_class($e), $e->getMessage()));
                error_log('[Predis] with conf: ' . $conf->toJSON());
                throw CacheException::withConnectionErrorFor('Predis');
            }
        } catch (Exception $e) {
            throw CacheException::from($e);
        }

        return $client;
    }


    private function createMemcachedClient(MemcachedConfiguration $conf): Cache
    {
        $client = new \Memcached($conf->get('id'));
        $client->setOptions($conf->getOptions());

        if (empty($client->getServerList())) {
            $client->addServers($conf->getServers());
        }

        return new MemcachedClient($client, $conf->getTtl());
    }

    /**
     * @param Configuration $conf
     *
     * @return \Psr\Log\LoggerInterface
     */
    private function getLogger($conf): LoggerInterface
    {
        $logger = $conf->logger ?? new NullLogger;


        if ($logger instanceof LoggerInterface) {
            return $logger;
        }

        throw CacheException::forUnsupportedLogger(LoggerInterface::class, get_class($logger));
    }
}

kodedphp / cache-simple

Push — master ( 5a87d9...5af04f )

CacheClientFactory::createRedisClient() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
