geckon01/predis
1
0
Fork 0
mirror of https://github.com/predis/predis.git synced 2026-09-11 19:07:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added support for new arguments for EXPIRE, EXPIREAT commands (#1046)

Browse Source
This commit is contained in:
Vladyslav Vildanov
2023-01-25 18:00:23 +02:00
committed by GitHub
parent c541617333
commit 50e005bfe3
7 changed files with 169 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ClientContextInterface.php
+2 -2
View File
@@ -24,8 +24,8 @@ use Predis\Command\CommandInterface;
* @method $this del(array|string $keys)
* @method $this dump($key)
* @method $this exists($key)
* @method $this expire($key, $seconds)
* @method $this expireat($key, $timestamp)
* @method $this expire($key, $seconds, string $expireOption = '')
* @method $this expireat($key, $timestamp, string $expireOption = '')
* @method $this expiretime(string $key)
* @method $this keys($pattern)
* @method $this move($key, $db)
src/ClientInterface.php
+2 -2
View File
@@ -33,8 +33,8 @@ use Predis\Response\Status;
* @method int del(string[]|string $keyOrKeys, string ...$keys = null)
* @method string|null dump(string $key)
* @method int exists(string $key)
* @method int expire(string $key, int $seconds)
* @method int expireat(string $key, int $timestamp)
* @method int expire(string $key, int $seconds, string $expireOption = '')
* @method int expireat(string $key, int $timestamp, string $expireOption = '')
* @method int expiretime(string $key)
* @method array keys(string $pattern)
* @method int move(string $key, int $db)
src/Command/Redis/EXPIRE.php
+7
View File
@@ -13,12 +13,19 @@
namespace Predis\Command\Redis;
use Predis\Command\Command as RedisCommand;
use Predis\Command\Traits\Expire\ExpireOptions;
/**
* @see http://redis.io/commands/expire
*
* Set a timeout on key.
* After the timeout has expired, the key will automatically be deleted.
* A key with an associated timeout is often said to be volatile in Redis terminology.
*/
class EXPIRE extends RedisCommand
{
use ExpireOptions;
/**
* {@inheritdoc}
*/
src/Command/Redis/EXPIREAT.php
+6
View File
@@ -13,12 +13,18 @@
namespace Predis\Command\Redis;
use Predis\Command\Command as RedisCommand;
use Predis\Command\Traits\Expire\ExpireOptions;
/**
* @see http://redis.io/commands/expireat
*
* EXPIREAT has the same effect and semantic as EXPIRE, but instead of specifying
* the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp
*/
class EXPIREAT extends RedisCommand
{
use ExpireOptions;
/**
* {@inheritdoc}
*/
src/Command/Traits/Expire/ExpireOptions.php
+36
View File
@@ -0,0 +1,36 @@
<?php
/*
* This file is part of the Predis package.
*
* (c) 2009-2020 Daniele Alessandri
* (c) 2021-2023 Till Krüss
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Predis\Command\Traits\Expire;
trait ExpireOptions
{
private static $argumentEnum = [
'nx' => 'NX',
'xx' => 'XX',
'gt' => 'GT',
'lt' => 'LT',
];
public function setArguments(array $arguments)
{
$value = array_pop($arguments);
if (in_array(strtoupper($value), self::$argumentEnum, true)) {
$arguments[] = self::$argumentEnum[strtolower($value)];
} else {
$arguments[] = $value;
}
parent::setArguments($arguments);
}
}
tests/Predis/Command/Redis/EXPIREAT_Test.php
+57
View File
@@ -90,6 +90,33 @@ class EXPIREAT_Test extends PredisCommandTestCase
$this->assertSame(0, $redis->exists('foo'));
}
/**
* @medium
* @group connected
* @dataProvider keysProvider
* @group slow
* @param array $firstKeyArguments
* @param array $secondKeyArguments
* @param array $positivePathArguments
* @param array $negativePathArguments
* @return void
* @requiresRedisVersion >= 7.0.0
*/
public function testSetNewExpirationTimeWithExpireOptions(
array $firstKeyArguments,
array $secondKeyArguments,
array $positivePathArguments,
array $negativePathArguments
): void {
$redis = $this->getClient();
$redis->set(...$firstKeyArguments);
$redis->set(...$secondKeyArguments);
$this->assertSame(1, $redis->expireat(...$positivePathArguments));
$this->assertSame(0, $redis->expireat(...$negativePathArguments));
}
/**
* @group connected
*/
@@ -103,4 +130,34 @@ class EXPIREAT_Test extends PredisCommandTestCase
$this->assertSame(1, $redis->expireat('foo', $now - 100));
$this->assertSame(0, $redis->exists('foo'));
}
public function keysProvider(): array
{
return [
'only if key has no expiry' => [
['noExpiry', 'value'],
['withExpiry', 'value', 'EX', 10],
['noExpiry', time() + 10, 'NX'],
['withExpiry', time() + 10, 'NX'],
],
'only if key has expiry' => [
['noExpiry', 'value'],
['withExpiry', 'value', 'EX', 10],
['withExpiry', time() + 10, 'XX'],
['noExpiry', time() + 10, 'XX'],
],
'only if new expiry is greater then current one' => [
['newExpiryLower', 'value', 'EXAT', time() + 1000],
['newExpiryGreater', 'value', 'EXAT', time() + 10],
['newExpiryGreater', time() + 20, 'GT'],
['newExpiryLower', time() + 20, 'GT'],
],
'only if new expiry is lower then current one' => [
['newExpiryLower', 'value', 'EXAT', time() + 1000],
['newExpiryGreater', 'value', 'EXAT', time() + 10],
['newExpiryLower', time() + 20, 'LT'],
['newExpiryGreater', time() + 20, 'LT'],
],
];
}
}
tests/Predis/Command/Redis/EXPIRE_Test.php
+59 -2
View File
@@ -39,8 +39,8 @@ class EXPIRE_Test extends PredisCommandTestCase
*/
public function testFilterArguments(): void
{
$arguments = ['key', 'ttl'];
$expected = ['key', 'ttl'];
$arguments = ['key', 'ttl', 'xx'];
$expected = ['key', 'ttl', 'XX'];
$command = $this->getCommand();
$command->setArguments($arguments);
@@ -87,6 +87,33 @@ class EXPIRE_Test extends PredisCommandTestCase
$this->assertSame(0, $redis->exists('foo'));
}
/**
* @medium
* @group connected
* @dataProvider keysProvider
* @group slow
* @param array $firstKeyArguments
* @param array $secondKeyArguments
* @param array $positivePathArguments
* @param array $negativePathArguments
* @return void
* @requiresRedisVersion >= 7.0.0
*/
public function testSetNewExpirationTimeWithExpireOptions(
array $firstKeyArguments,
array $secondKeyArguments,
array $positivePathArguments,
array $negativePathArguments
): void {
$redis = $this->getClient();
$redis->set(...$firstKeyArguments);
$redis->set(...$secondKeyArguments);
$this->assertSame(1, $redis->expire(...$positivePathArguments));
$this->assertSame(0, $redis->expire(...$negativePathArguments));
}
/**
* @group connected
*/
@@ -99,4 +126,34 @@ class EXPIRE_Test extends PredisCommandTestCase
$this->assertSame(1, $redis->expire('foo', -10));
$this->assertSame(0, $redis->exists('foo'));
}
public function keysProvider(): array
{
return [
'only if key has no expiry' => [
['noExpiry', 'value'],
['withExpiry', 'value', 'EX', 10],
['noExpiry', 2, 'NX'],
['withExpiry', 2, 'NX'],
],
'only if key has expiry' => [
['noExpiry', 'value'],
['withExpiry', 'value', 'EX', 10],
['withExpiry', 2, 'XX'],
['noExpiry', 2, 'XX'],
],
'only if new expiry is greater then current one' => [
['newExpiryLower', 'value', 'EXAT', time() + 1000],
['newExpiryGreater', 'value', 'EXAT', time() + 10],
['newExpiryGreater', 20, 'GT'],
['newExpiryLower', 20, 'GT'],
],
'only if new expiry is lower then current one' => [
['newExpiryLower', 'value', 'EXAT', time() + 1000],
['newExpiryGreater', 'value', 'EXAT', time() + 10],
['newExpiryLower', 20, 'LT'],
['newExpiryGreater', 20, 'LT'],
],
];
}
}