Yiisoft\Cache\Redis\RedisCache

Complexity

Total Complexity

43

Size/Duplication

Total Lines	302
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	5	2
A	setMultiple()	0	32	5
A	deleteMultiple()	0	13	4
A	has()	0	6	2
A	validateKey()	0	4	3
A	set()	0	16	3
A	delete()	0	3	2
A	isInfinityTtl()	0	3	1
A	getMultiple()	0	18	3
A	validateKeys()	0	8	3
A	__construct()	0	4	1
A	iterableToArray()	0	4	2
A	normalizeTtl()	0	13	3
A	isCluster()	0	12	4
A	isExpiredTtl()	0	3	2
A	clear()	0	13	3

<?php

declare(strict_types=1);

namespace Yiisoft\Cache\Redis;

use DateInterval;
use DateTime;
use Predis\Client;
use Predis\ClientInterface;
use Predis\Connection\ConnectionInterface;
use Predis\Connection\StreamConnection;
use Predis\Response\Status;
use Psr\SimpleCache\CacheInterface;
use Traversable;

use function array_fill_keys;
use function array_keys;
use function array_map;
use function count;
use function iterator_to_array;
use function serialize;
use function strpbrk;
use function unserialize;

/**
 * RedisCache stores cache data in a Redis.
 *
 * Please refer to {@see CacheInterface} for common cache operations that are supported by RedisCache.
 */
final class RedisCache implements CacheInterface
{
    /**
     * @var ClientInterface $client Predis client instance to use.
     */
    private ClientInterface $client;

    /**
     * @var array<ConnectionInterface>|ConnectionInterface $connections Predis connections instance to use
     */
    private ConnectionInterface|array $connections;

    /**
     * @param ClientInterface $client Predis client instance to use.
     */
    public function __construct(ClientInterface $client)
    {
        $this->client = $client;
        $this->connections = $this->client->getConnection();
    }

    /**
     * Checking Predis cluster usage
     *
     * @return bool
     */
    public function isCluster(): bool
    {
        /** @psalm-suppress MixedAssignment, PossibleRawObjectIteration */
        foreach ($this->connections as $connection) {
            /** @var StreamConnection $connection */
            $cluster = (new Client($connection->getParameters()))->info('Cluster');
            if (isset($cluster['Cluster']['cluster_enabled']) && 1 === (int)$cluster['Cluster']['cluster_enabled']) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param string $key
     * @param mixed|null $default
     *
     * @throws InvalidArgumentException
     *
     * @return mixed
     */
    public function get(string $key, mixed $default = null): mixed
    {
        $this->validateKey($key);
        $value = $this->client->get($key);
        return $value === null ? $default : unserialize($value);
    }

    /**
     * @param string $key
     * @param mixed $value
     * @param DateInterval|int|null $ttl
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function set(string $key, mixed $value, null|int|DateInterval $ttl = null): bool
    {
        $ttl = $this->normalizeTtl($ttl);

        if ($this->isExpiredTtl($ttl)) {
            return $this->delete($key);
        }

        $this->validateKey($key);

        /** @var Status|null $result */
        $result = $this->isInfinityTtl($ttl)
            ? $this->client->set($key, serialize($value))
            : $this->client->set($key, serialize($value), 'EX', $ttl);

        return $result !== null;
    }

    /**
     * @param string $key
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function delete(string $key): bool
    {
        return !$this->has($key) || $this->client->del($key) === 1;
    }

    /**
     * If a cluster is used, all nodes will be cleared
     *
     * @return bool
     */
    public function clear(): bool
    {
        if ($this->isCluster()) {
            /** @psalm-suppress MixedAssignment, PossibleRawObjectIteration */
            foreach ($this->connections as $connection) {
                /** @var StreamConnection $connection */
                $client = new Client($connection->getParameters());
                $client->flushdb();
            }
            return true;
        }

        return $this->client->flushdb() !== null;
    }

    /**
     * @param iterable<string> $keys
     * @param mixed $default
     *
     * @throws InvalidArgumentException
     *
     * @return iterable<string, mixed>
     */
    public function getMultiple(iterable $keys, mixed $default = null): iterable
    {
        /** @var string[] $keys */
        $keys = $this->iterableToArray($keys);
        $this->validateKeys($keys);
        $values = array_fill_keys($keys, $default);
        /** @var null[]|string[] $valuesFromCache */
        $valuesFromCache = $this->client->mget($keys);

        $i = 0;

        /** @psalm-suppress MixedAssignment */
        foreach ($values as $key => $value) {
            $values[$key] = isset($valuesFromCache[$i]) ? unserialize($valuesFromCache[$i]) : $value;
            $i++;
        }

        return $values;
    }

    /**
     * @param iterable $values
     * @param DateInterval|int|null $ttl
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function setMultiple(iterable $values, null|int|DateInterval $ttl = null): bool
    {
        $values = $this->iterableToArray($values);
        $keys = array_map('\strval', array_keys($values));
        $this->validateKeys($keys);
        $ttl = $this->normalizeTtl($ttl);
        $serializeValues = [];

        if ($this->isExpiredTtl($ttl)) {
            return $this->deleteMultiple($keys);
        }

        /** @var mixed $value */
        foreach ($values as $key => $value) {
            $serializeValues[$key] = serialize($value);
        }

        if ($this->isInfinityTtl($ttl)) {
            $this->client->mset($serializeValues);
            return true;
        }

        $this->client->multi();
        $this->client->mset($serializeValues);

        foreach ($keys as $key) {
            $this->client->expire($key, (int)$ttl);
        }

        $results = $this->client->exec();

        return !in_array(null, (array)$results, true);
    }

    /**
     * @param iterable $keys
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function deleteMultiple(iterable $keys): bool
    {
        $keys = $this->iterableToArray($keys);

        /** @psalm-suppress MixedAssignment, MixedArgument */
        foreach ($keys as $index => $key) {
            if (!$this->has($key)) {
                unset($keys[$index]);
            }
        }

        /** @psalm-suppress MixedArgumentTypeCoercion */
        return empty($keys) || $this->client->del($keys) === count($keys);
    }

    /**
     * @param string $key
     *
     * @throws InvalidArgumentException
     *
     * @return bool
     */
    public function has(string $key): bool
    {
        $this->validateKey($key);
        $ttl = $this->client->ttl($key);
        /** "-1" - if the key exists but has no associated expire {@see https://redis.io/commands/ttl}. */
        return $ttl > 0 || $ttl === -1;
    }

    /**
     * Normalizes cache TTL handling `null` value, strings and {@see DateInterval} objects.
     *
     * @param DateInterval|int|string|null $ttl The raw TTL.
     *
     * @return int|null TTL value as UNIX timestamp.
     */
    private function normalizeTtl(null|int|string|DateInterval $ttl): ?int
    {
        if ($ttl === null) {
            return null;
        }

        if ($ttl instanceof DateInterval) {
            return (new DateTime('@0'))
                ->add($ttl)
                ->getTimestamp();
        }

        return (int) $ttl;
    }

    /**
     * Converts iterable to array.
     *
     * @param iterable $iterable
     *
     * @return array
     */
    private function iterableToArray(iterable $iterable): array
    {
        /** @psalm-suppress RedundantCast */
        return $iterable instanceof Traversable ? iterator_to_array($iterable) : (array) $iterable;
    }

    /**
     * @param string $key
     *
     * @throws InvalidArgumentException
     */
    private function validateKey(string $key): void
    {
        if ($key === '' || strpbrk($key, '{}()/\@:')) {
            throw new InvalidArgumentException('Invalid key value.');
        }
    }

    /**
     * @param string[] $keys
     *
     * @throws InvalidArgumentException
     */
    private function validateKeys(array $keys): void
    {
        if ([] === $keys) {
            throw new InvalidArgumentException('Invalid key values.');
        }

        foreach ($keys as $key) {
            $this->validateKey($key);
        }
    }

    /**
     * @param int|null $ttl
     *
     * @return bool
     */
    private function isExpiredTtl(?int $ttl): bool
    {
        return $ttl !== null && $ttl <= 0;
    }

    /**
     * @param int|null $ttl
     *
     * @return bool
     */
    private function isInfinityTtl(?int $ttl): bool
    {
        return $ttl === null;
    }
}