Skip to content

Commit 50e005b

Browse files
vladvildanovvladvildanov
authored
Added support for new arguments for EXPIRE, EXPIREAT commands (#1046)
1 parent c541617 commit 50e005b

File tree

7 files changed

+169
-6
lines changed

7 files changed

+169
-6
lines changed

‎src/ClientContextInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
* @method $this del(array|string $keys)
2525
* @method $this dump($key)
2626
* @method $this exists($key)
27-
* @method $this expire($key, $seconds)
28-
* @method $this expireat($key, $timestamp)
27+
* @method $this expire($key, $seconds, string $expireOption = '')
28+
* @method $this expireat($key, $timestamp, string $expireOption = '')
2929
* @method $this expiretime(string $key)
3030
* @method $this keys($pattern)
3131
* @method $this move($key, $db)

‎src/ClientInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
* @method int del(string[]|string $keyOrKeys, string ...$keys = null)
3434
* @method string|null dump(string $key)
3535
* @method int exists(string $key)
36-
* @method int expire(string $key, int $seconds)
37-
* @method int expireat(string $key, int $timestamp)
36+
* @method int expire(string $key, int $seconds, string $expireOption = '')
37+
* @method int expireat(string $key, int $timestamp, string $expireOption = '')
3838
* @method int expiretime(string $key)
3939
* @method array keys(string $pattern)
4040
* @method int move(string $key, int $db)

‎src/Command/Redis/EXPIRE.php

+7
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,19 @@
1313
namespace Predis\Command\Redis;
1414

1515
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\Expire\ExpireOptions;
1617

1718
/**
1819
* @see http://redis.io/commands/expire
20+
*
21+
* Set a timeout on key.
22+
* After the timeout has expired, the key will automatically be deleted.
23+
* A key with an associated timeout is often said to be volatile in Redis terminology.
1924
*/
2025
class EXPIRE extends RedisCommand
2126
{
27+
use ExpireOptions;
28+
2229
/**
2330
* {@inheritdoc}
2431
*/

‎src/Command/Redis/EXPIREAT.php

+6
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,18 @@
1313
namespace Predis\Command\Redis;
1414

1515
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\Expire\ExpireOptions;
1617

1718
/**
1819
* @see http://redis.io/commands/expireat
20+
*
21+
* EXPIREAT has the same effect and semantic as EXPIRE, but instead of specifying
22+
* the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp
1923
*/
2024
class EXPIREAT extends RedisCommand
2125
{
26+
use ExpireOptions;
27+
2228
/**
2329
* {@inheritdoc}
2430
*/

‎src/Command/Traits/Expire/ExpireOptions.php

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Traits\Expire;
14+
15+
trait ExpireOptions
16+
{
17+
private static $argumentEnum = [
18+
'nx' => 'NX',
19+
'xx' => 'XX',
20+
'gt' => 'GT',
21+
'lt' => 'LT',
22+
];
23+
24+
public function setArguments(array $arguments)
25+
{
26+
$value = array_pop($arguments);
27+
28+
if (in_array(strtoupper($value), self::$argumentEnum, true)) {
29+
$arguments[] = self::$argumentEnum[strtolower($value)];
30+
} else {
31+
$arguments[] = $value;
32+
}
33+
34+
parent::setArguments($arguments);
35+
}
36+
}

‎tests/Predis/Command/Redis/EXPIREAT_Test.php

+57
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,33 @@ public function testCanExpireKeys(): void
9090
$this->assertSame(0, $redis->exists('foo'));
9191
}
9292

93+
/**
94+
* @medium
95+
* @group connected
96+
* @dataProvider keysProvider
97+
* @group slow
98+
* @param array $firstKeyArguments
99+
* @param array $secondKeyArguments
100+
* @param array $positivePathArguments
101+
* @param array $negativePathArguments
102+
* @return void
103+
* @requiresRedisVersion >= 7.0.0
104+
*/
105+
public function testSetNewExpirationTimeWithExpireOptions(
106+
array $firstKeyArguments,
107+
array $secondKeyArguments,
108+
array $positivePathArguments,
109+
array $negativePathArguments
110+
): void {
111+
$redis = $this->getClient();
112+
113+
$redis->set(...$firstKeyArguments);
114+
$redis->set(...$secondKeyArguments);
115+
116+
$this->assertSame(1, $redis->expireat(...$positivePathArguments));
117+
$this->assertSame(0, $redis->expireat(...$negativePathArguments));
118+
}
119+
93120
/**
94121
* @group connected
95122
*/
@@ -103,4 +130,34 @@ public function testDeletesKeysOnPastUnixTime(): void
103130
$this->assertSame(1, $redis->expireat('foo', $now - 100));
104131
$this->assertSame(0, $redis->exists('foo'));
105132
}
133+
134+
public function keysProvider(): array
135+
{
136+
return [
137+
'only if key has no expiry' => [
138+
['noExpiry', 'value'],
139+
['withExpiry', 'value', 'EX', 10],
140+
['noExpiry', time() + 10, 'NX'],
141+
['withExpiry', time() + 10, 'NX'],
142+
],
143+
'only if key has expiry' => [
144+
['noExpiry', 'value'],
145+
['withExpiry', 'value', 'EX', 10],
146+
['withExpiry', time() + 10, 'XX'],
147+
['noExpiry', time() + 10, 'XX'],
148+
],
149+
'only if new expiry is greater then current one' => [
150+
['newExpiryLower', 'value', 'EXAT', time() + 1000],
151+
['newExpiryGreater', 'value', 'EXAT', time() + 10],
152+
['newExpiryGreater', time() + 20, 'GT'],
153+
['newExpiryLower', time() + 20, 'GT'],
154+
],
155+
'only if new expiry is lower then current one' => [
156+
['newExpiryLower', 'value', 'EXAT', time() + 1000],
157+
['newExpiryGreater', 'value', 'EXAT', time() + 10],
158+
['newExpiryLower', time() + 20, 'LT'],
159+
['newExpiryGreater', time() + 20, 'LT'],
160+
],
161+
];
162+
}
106163
}

‎tests/Predis/Command/Redis/EXPIRE_Test.php

+59-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ protected function getExpectedId(): string
3939
*/
4040
public function testFilterArguments(): void
4141
{
42-
$arguments = ['key', 'ttl'];
43-
$expected = ['key', 'ttl'];
42+
$arguments = ['key', 'ttl', 'xx'];
43+
$expected = ['key', 'ttl', 'XX'];
4444

4545
$command = $this->getCommand();
4646
$command->setArguments($arguments);
@@ -87,6 +87,33 @@ public function testCanExpireKeys(): void
8787
$this->assertSame(0, $redis->exists('foo'));
8888
}
8989

90+
/**
91+
* @medium
92+
* @group connected
93+
* @dataProvider keysProvider
94+
* @group slow
95+
* @param array $firstKeyArguments
96+
* @param array $secondKeyArguments
97+
* @param array $positivePathArguments
98+
* @param array $negativePathArguments
99+
* @return void
100+
* @requiresRedisVersion >= 7.0.0
101+
*/
102+
public function testSetNewExpirationTimeWithExpireOptions(
103+
array $firstKeyArguments,
104+
array $secondKeyArguments,
105+
array $positivePathArguments,
106+
array $negativePathArguments
107+
): void {
108+
$redis = $this->getClient();
109+
110+
$redis->set(...$firstKeyArguments);
111+
$redis->set(...$secondKeyArguments);
112+
113+
$this->assertSame(1, $redis->expire(...$positivePathArguments));
114+
$this->assertSame(0, $redis->expire(...$negativePathArguments));
115+
}
116+
90117
/**
91118
* @group connected
92119
*/
@@ -99,4 +126,34 @@ public function testDeletesKeysOnNegativeTTL(): void
99126
$this->assertSame(1, $redis->expire('foo', -10));
100127
$this->assertSame(0, $redis->exists('foo'));
101128
}
129+
130+
public function keysProvider(): array
131+
{
132+
return [
133+
'only if key has no expiry' => [
134+
['noExpiry', 'value'],
135+
['withExpiry', 'value', 'EX', 10],
136+
['noExpiry', 2, 'NX'],
137+
['withExpiry', 2, 'NX'],
138+
],
139+
'only if key has expiry' => [
140+
['noExpiry', 'value'],
141+
['withExpiry', 'value', 'EX', 10],
142+
['withExpiry', 2, 'XX'],
143+
['noExpiry', 2, 'XX'],
144+
],
145+
'only if new expiry is greater then current one' => [
146+
['newExpiryLower', 'value', 'EXAT', time() + 1000],
147+
['newExpiryGreater', 'value', 'EXAT', time() + 10],
148+
['newExpiryGreater', 20, 'GT'],
149+
['newExpiryLower', 20, 'GT'],
150+
],
151+
'only if new expiry is lower then current one' => [
152+
['newExpiryLower', 'value', 'EXAT', time() + 1000],
153+
['newExpiryGreater', 'value', 'EXAT', time() + 10],
154+
['newExpiryLower', 20, 'LT'],
155+
['newExpiryGreater', 20, 'LT'],
156+
],
157+
];
158+
}
102159
}

0 commit comments

Comments
 (0)