RedisCache::isInfinityTtl() - Code Metrics - yiisoft/cache-redis - Measure and Improve Code Quality continuously with Scrutinizer

RedisCache::isInfinityTtl() A
last analyzed 2024-05-16 07:33 UTC

↳ Parent: RedisCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?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 array<ConnectionInterface>|ConnectionInterface $connections Predis connection instances to use.
     */
    private ConnectionInterface|array $connections;

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

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

        return false;
    }

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

    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;
    }

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

    /**
     * @inheritDoc
     *
     * If a cluster is used, all nodes will be cleared.
     */
    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;
    }

    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);

        if ($this->isCluster()) {
            foreach ($keys as $key) {
                /** @var string|null $value */
                $value = $this->get($key);
                if (null !== $value) {
                    /** @psalm-suppress MixedAssignment */
                    $values[$key] = unserialize($value);
                }
            }
        } else {
            /** @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;
    }

    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);
        }

        foreach ($values as $key => $value) {
            $serializeValues[$key] = serialize($value);
        }

        $results = [];
        if ($this->isCluster()) {
            foreach ($serializeValues as $key => $value) {
                $this->set((string)$key, $value, $this->isInfinityTtl($ttl) ? null : $ttl);
            }
        } else {
            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);
            }

            /** @var array|null $results */
            $results = $this->client->exec();
        }

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

    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);
    }

    public function has(string $key): bool
    {
        $this->validateKey($key);
        /** @var int $ttl */
        $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.
     *
     * @psalm-template T
     * @psalm-param iterable<T> $iterable
     * @psalm-return array<array-key,T>
     */
    private function iterableToArray(iterable $iterable): array
    {
        return $iterable instanceof Traversable ? iterator_to_array($iterable) : $iterable;

    }

    /**
     * @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);
        }
    }

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

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Cache\Redis;
6
7		use DateInterval;
8		use DateTime;
9		use Predis\Client;
10		use Predis\ClientInterface;
11		use Predis\Connection\ConnectionInterface;
12		use Predis\Connection\StreamConnection;
13		use Predis\Response\Status;
14		use Psr\SimpleCache\CacheInterface;
15		use Traversable;
16
17		use function array_fill_keys;
18		use function array_keys;
19		use function array_map;
20		use function count;
21		use function iterator_to_array;
22		use function serialize;
23		use function strpbrk;
24		use function unserialize;
25
26		/**
27		* RedisCache stores cache data in a Redis.
28		*
29		* Please refer to {@see CacheInterface} for common cache operations that are supported by RedisCache.
30		*/
31		final class RedisCache implements CacheInterface
32		{
33		/**
34		* @var array<ConnectionInterface>\|ConnectionInterface $connections Predis connection instances to use.
35		*/
36		private ConnectionInterface\|array $connections;
37
38		/**
39		* @param ClientInterface $client Predis client instance to use.
40		*/
41	226	public function __construct(private ClientInterface $client)
42		{
43	226	$this->connections = $this->client->getConnection();
44		}
45
46		/**
47		* Returns whether Predis cluster is used.
48		*
49		* @return bool Whether Predis cluster is used.
50		*/
51	226	private function isCluster(): bool
52		{
53		/** @psalm-suppress MixedAssignment, PossibleRawObjectIteration */
54	226	foreach ($this->connections as $connection) {
55		/** @var StreamConnection $connection */
56	108	$cluster = (new Client($connection->getParameters()))->info('Cluster');
57		/** @psalm-suppress MixedArrayAccess */
58	108	if (isset($cluster['Cluster']['cluster_enabled']) && 1 === (int)$cluster['Cluster']['cluster_enabled']) {
59	108	return true;
60		}
61		}
62
63	118	return false;
64		}
65
66	134	public function get(string $key, mixed $default = null): mixed
67		{
68	134	$this->validateKey($key);
69		/** @var string\|null $value */
70	130	$value = $this->client->get($key);
71	130	return $value === null ? $default : unserialize($value);
72		}
73
74	175	public function set(string $key, mixed $value, null\|int\|DateInterval $ttl = null): bool
75		{
76	175	$ttl = $this->normalizeTtl($ttl);
77
78	175	if ($this->isExpiredTtl($ttl)) {
79	1	return $this->delete($key);
80		}
81
82	174	$this->validateKey($key);
83
84		/** @var Status\|null $result */
85	172	$result = $this->isInfinityTtl($ttl)
86	148	? $this->client->set($key, serialize($value))
87	24	: $this->client->set($key, serialize($value), 'EX', $ttl);
88
89	172	return $result !== null;
90		}
91
92	31	public function delete(string $key): bool
93		{
94	31	return !$this->has($key) \|\| $this->client->del($key) === 1;
95		}
96
97		/**
98		* @inheritDoc
99		*
100		* If a cluster is used, all nodes will be cleared.
101		*/
102	226	public function clear(): bool
103		{
104	226	if ($this->isCluster()) {
105		/** @psalm-suppress MixedAssignment, PossibleRawObjectIteration */
106	108	foreach ($this->connections as $connection) {
107		/** @var StreamConnection $connection */
108	108	$client = new Client($connection->getParameters());
109	108	$client->flushdb();
110		}
111	108	return true;
112		}
113
114	118	return $this->client->flushdb() !== null;
115		}
116
117	18	public function getMultiple(iterable $keys, mixed $default = null): iterable
118		{
119		/** @var string[] $keys */
120	18	$keys = $this->iterableToArray($keys);
121	18	$this->validateKeys($keys);
122	12	$values = array_fill_keys($keys, $default);
123
124	12	if ($this->isCluster()) {
125	5	foreach ($keys as $key) {
126		/** @var string\|null $value */
127	5	$value = $this->get($key);
128	5	if (null !== $value) {
129		/** @psalm-suppress MixedAssignment */
130	4	$values[$key] = unserialize($value);
131		}
132		}
133		} else {
134		/** @var null[]\|string[] $valuesFromCache */
135	7	$valuesFromCache = $this->client->mget($keys);
136
137	7	$i = 0;
138		/** @psalm-suppress MixedAssignment */
139	7	foreach ($values as $key => $value) {
140	7	$values[$key] = isset($valuesFromCache[$i]) ? unserialize($valuesFromCache[$i]) : $value;
141	7	$i++;
142		}
143		}
144
145	12	return $values;
146		}
147
148	18	public function setMultiple(iterable $values, null\|int\|DateInterval $ttl = null): bool
149		{
150	18	$values = $this->iterableToArray($values);
151	18	$keys = array_map('\strval', array_keys($values));
152	18	$this->validateKeys($keys);
153	16	$ttl = $this->normalizeTtl($ttl);
154	16	$serializeValues = [];
155
156	16	if ($this->isExpiredTtl($ttl)) {
157	1	return $this->deleteMultiple($keys);
158		}
159
160		foreach ($values as $key => $value) {
161	15	$serializeValues[$key] = serialize($value);
162	15	}
163
164		$results = [];
165	15	if ($this->isCluster()) {
166	15	foreach ($serializeValues as $key => $value) {
167	4	$this->set((string)$key, $value, $this->isInfinityTtl($ttl) ? null : $ttl);
168	4	}
169		} else {
170		if ($this->isInfinityTtl($ttl)) {
171	11	$this->client->mset($serializeValues);
172	8	return true;
173	8	}
174
175		$this->client->multi();
176	3	$this->client->mset($serializeValues);
177	3
178		foreach ($keys as $key) {
179	3	$this->client->expire($key, (int)$ttl);
180	3	}
181
182		/** @var array\|null $results */
183		$results = $this->client->exec();
184	3	}
185
186		return !in_array(null, (array)$results, true);
187	7	}
188
189		public function deleteMultiple(iterable $keys): bool
190	8	{
191		$keys = $this->iterableToArray($keys);
192	8
193		/** @psalm-suppress MixedAssignment, MixedArgument */
194		foreach ($keys as $index => $key) {
195	8	if (!$this->has($key)) {
196	8	unset($keys[$index]);
197	3	}
198		}
199
200		/** @psalm-suppress MixedArgumentTypeCoercion */
201		return empty($keys) \|\| $this->client->del($keys) === count($keys);
202	4	}
203
204		public function has(string $key): bool
205	64	{
206		$this->validateKey($key);
207	64	/** @var int $ttl */
208		$ttl = $this->client->ttl($key);
209	52	/** "-1" - if the key exists but has no associated expire {@see https://redis.io/commands/ttl}. */
210		return $ttl > 0 \|\| $ttl === -1;
211	52	}
212
213		/**
214		* Normalizes cache TTL handling `null` value, strings and {@see DateInterval} objects.
215		*
216		* @param DateInterval\|int\|string\|null $ttl The raw TTL.
217		*
218		* @return int\|null TTL value as UNIX timestamp.
219		*/
220		private function normalizeTtl(null\|int\|string\|DateInterval $ttl): ?int
221	200	{
222		if ($ttl === null) {
223	200	return null;
224	160	}
225
226		if ($ttl instanceof DateInterval) {
227	40	return (new DateTime('@0'))
228	4	->add($ttl)
229	4	->getTimestamp();
230	4	}
231
232		return (int) $ttl;
233	36	}
234
235		/**
236		* Converts iterable to array.
237		*
238		* @psalm-template T
239		* @psalm-param iterable<T> $iterable
240		* @psalm-return array<array-key,T>
241	30	*/
242		private function iterableToArray(iterable $iterable): array
243		{
244	30	return $iterable instanceof Traversable ? iterator_to_array($iterable) : $iterable;
		0 ignored issues – show Bug Best Practice introduced 2024-02-18 14:31 UTC by Report Bug Copy Issue Report The expression `return $iterable instanc...($iterable) : $iterable` could return the type `iterable` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
245		}
246
247		/**
248		* @throws InvalidArgumentException
249		*/
250	208	private function validateKey(string $key): void
251		{
252	208	if ($key === '' \|\| strpbrk($key, '{}()/\@:')) {
253	22	throw new InvalidArgumentException('Invalid key value.');
254		}
255		}
256
257		/**
258		* @param string[] $keys
259		*
260		* @throws InvalidArgumentException
261		*/
262	26	private function validateKeys(array $keys): void
263		{
264	26	if ([] === $keys) {
265	4	throw new InvalidArgumentException('Invalid key values.');
266		}
267
268	22	foreach ($keys as $key) {
269	22	$this->validateKey($key);
270		}
271		}
272
273		/**
274		* @return bool
275		*/
276	186	private function isExpiredTtl(?int $ttl): bool
277		{
278	186	return $ttl !== null && $ttl <= 0;
279		}
280
281		/**
282		* @return bool
283		*/
284	183	private function isInfinityTtl(?int $ttl): bool
285		{
286	183	return $ttl === null;
287		}
288		}
289

yiisoft / cache-redis

RedisCache::isInfinityTtl() A last analyzed 2024-05-16 07:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RedisCache::isInfinityTtl() A
last analyzed 2024-05-16 07:33 UTC