BeyondCode\SelfDiagnosis\Checks\RedisCanBeAccessed

Complexity

Total Complexity

10

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

92%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	4	1
B	check()	0	25	6
A	message()	0	6	1
A	testConnection()	0	10	2

<?php

namespace BeyondCode\SelfDiagnosis\Checks;

use Illuminate\Contracts\Redis\Factory as RedisFactory;
use Illuminate\Redis\Connections\PhpRedisConnection;

class RedisCanBeAccessed implements Check
{
    private $message;

    /**
     * The name of the check.
     *
     * @param array $config
     * @return string
     */
    public function name(array $config): string
    {
        return trans('self-diagnosis::checks.redis_can_be_accessed.name');
    }

    /**
     * Perform the actual verification of this check.
     *
     * @param array $config
     * @return bool
     */
    public function check(array $config): bool
    {
        try {
            if (array_get($config, 'default_connection', true)) {
                if (!$this->testConnection()) {
                    $this->message = trans('self-diagnosis::checks.redis_can_be_accessed.message.default_cache');
                    return false;
                }
            }

            foreach (array_get($config, 'connections', []) as $connection) {
                if (!$this->testConnection($connection)) {
                    $this->message = trans('self-diagnosis::checks.redis_can_be_accessed.message.named_cache', [
                        'name' => $connection,
                    ]);
                    return false;
                }
            }
        } catch (\Exception $e) {
            $this->message = $e->getMessage();
            return false;
        }

        return true;
    }

    /**
     * The error message to display in case the check does not pass.
     *
     * @param array $config
     * @return string
     */
    public function message(array $config): string
    {
        return trans('self-diagnosis::checks.redis_can_be_accessed.message.not_accessible', [
            'error' => $this->message,
        ]);
    }

    /**
     * Tests a redis connection and returns whether the connection is opened or not.
     *
     * @param string|null $name
     * @return bool
     */
    private function testConnection(string $name = null): bool
    {
        $redis = app(RedisFactory::class);
        $connection = $redis->connection($name);
        // phpredis connects automatically
        if (!$connection instanceof PhpRedisConnection) {
            $connection->connect();
        }
        return $connection->isConnected();
    }
}