Skip to content

Commit 292bc43

Browse files
vladvildanovtillkruss
vladvildanov
and
tillkruss
authored
Added support for XAUTOCLAIM command (#1328)
* Codestyle changes related to php-cs-fixer update (#1311) * Codestyle changes * Added missing type-hints * Added GETDEL command to KeyPrefixProcessor (#1306) * Added GETDEL command to KeyPrefixProcessor * Added test coverage * Codestyle fixes * Added timeout after FT.CREATE call * Added support for JSON.MERGE command (#1304) * Added support for JSON.MSET command (#1307) * Fixed subcommand test bug (#1313) * Update CHANGELOG.md * Update CHANGELOG.md * Added support for XGROUP container commands * Added support for XREADGROUP command * Fixed bug with incorrect multiple words processing (#1325) * Fixed bug with incorrect multiple words processing * Convert subcommand string to lower case * Update SubcommandStrategyResolver.php * Added test coverage * Codestyle fixes --------- Co-authored-by: Till Krüss <[email protected]> * Added split words handling * Fixed command id to be lowercase * Fixed test decorator * Marked test as realy incompatible * Added support for XAUTOCLAIM command * Changed test decorator to run agains >= 7.0.0 * Remove old files --------- Co-authored-by: Till Krüss <[email protected]>
1 parent b18c56e commit 292bc43

File tree

3 files changed

+179
-0
lines changed

3 files changed

+179
-0
lines changed

‎src/ClientInterface.php

+1
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,7 @@
280280
* @method array tsrange(string $key, $fromTimestamp, $toTimestamp, ?RangeArguments $arguments = null)
281281
* @method array tsrevrange(string $key, $fromTimestamp, $toTimestamp, ?RangeArguments $arguments = null)
282282
* @method string xadd(string $key, array $dictionary, string $id = '*', array $options = null)
283+
* @method array xautoclaim(string $key, string $group, string $consumer, int $minIdleTime, string $start, ?int $count = null, bool $justId = false)
283284
* @method int xdel(string $key, string ...$id)
284285
* @method int xlen(string $key)
285286
* @method array xrevrange(string $key, string $end, string $start, ?int $count = null)

‎src/Command/Redis/XAUTOCLAIM.php

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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\Redis;
14+
15+
use Predis\Command\Command as RedisCommand;
16+
17+
class XAUTOCLAIM extends RedisCommand
18+
{
19+
public function getId()
20+
{
21+
return 'XAUTOCLAIM';
22+
}
23+
24+
public function setArguments(array $arguments)
25+
{
26+
$processedArguments = array_splice($arguments, 0, 5);
27+
28+
if (empty($arguments)) {
29+
parent::setArguments($processedArguments);
30+
31+
return;
32+
}
33+
34+
if ($arguments[0] !== null) {
35+
array_push($processedArguments, 'COUNT', $arguments[0]);
36+
}
37+
38+
if (count($arguments) >= 2 && true === $arguments[1]) {
39+
$processedArguments[] = 'JUSTID';
40+
}
41+
42+
parent::setArguments($processedArguments);
43+
}
44+
}

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

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
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\Redis;
14+
15+
use Predis\Response\ServerException;
16+
17+
class XAUTOCLAIM_Test extends PredisCommandTestCase
18+
{
19+
/**
20+
* {@inheritDoc}
21+
*/
22+
protected function getExpectedCommand(): string
23+
{
24+
return XAUTOCLAIM::class;
25+
}
26+
27+
/**
28+
* {@inheritDoc}
29+
*/
30+
protected function getExpectedId(): string
31+
{
32+
return 'XAUTOCLAIM';
33+
}
34+
35+
/**
36+
* @dataProvider argumentsProvider
37+
* @group disconnected
38+
*/
39+
public function testFilterArguments(array $actualArguments, array $expectedArguments): void
40+
{
41+
$command = $this->getCommand();
42+
$command->setArguments($actualArguments);
43+
44+
$this->assertSame($expectedArguments, $command->getArguments());
45+
}
46+
47+
/**
48+
* @group disconnected
49+
*/
50+
public function testParseResponse(): void
51+
{
52+
$this->assertSame(1, $this->getCommand()->parseResponse(1));
53+
}
54+
55+
/**
56+
* @group connected
57+
* @group relay-incompatible
58+
* @return void
59+
* @requiresRedisVersion >= 7.0.0
60+
*/
61+
public function testTransferStreamOwnershipToGivenConsumerGroup(): void
62+
{
63+
$redis = $this->getClient();
64+
65+
$entryId = $redis->xadd('stream', ['field' => 'value']);
66+
$this->assertEquals('OK', $redis->xgroup->create('stream', 'group', $entryId));
67+
68+
$nextEntryId = $redis->xadd('stream', ['newField' => 'newValue']);
69+
70+
$redis->xreadgroup(
71+
'group',
72+
'consumer',
73+
null,
74+
null,
75+
false,
76+
'stream',
77+
'>');
78+
79+
$expectedResponse = [
80+
'0-0',
81+
[
82+
[
83+
$nextEntryId,
84+
['newField', 'newValue'],
85+
],
86+
],
87+
[],
88+
];
89+
90+
$this->assertSame(
91+
$expectedResponse,
92+
$redis->xautoclaim('stream', 'group', 'another_consumer', 0, $entryId)
93+
);
94+
}
95+
96+
/**
97+
* @group connected
98+
* @return void
99+
* @requiresRedisVersion >= 6.2.0
100+
*/
101+
public function testThrowsExceptionOnNonExistingConsumerGroupOrStream(): void
102+
{
103+
$redis = $this->getClient();
104+
105+
$this->expectException(ServerException::class);
106+
$this->expectExceptionMessage(
107+
"NOGROUP No such key 'stream' or consumer group 'group'"
108+
);
109+
110+
$redis->xautoclaim('stream', 'group', 'another_consumer', 0, '0-0');
111+
}
112+
113+
public function argumentsProvider(): array
114+
{
115+
return [
116+
'with default arguments' => [
117+
['key', 'group', 'consumer', 10000, '0-0'],
118+
['key', 'group', 'consumer', 10000, '0-0'],
119+
],
120+
'with COUNT modifier' => [
121+
['key', 'group', 'consumer', 10000, '0-0', 20],
122+
['key', 'group', 'consumer', 10000, '0-0', 'COUNT', 20],
123+
],
124+
'with JUSTID modifier' => [
125+
['key', 'group', 'consumer', 10000, '0-0', null, true],
126+
['key', 'group', 'consumer', 10000, '0-0', 'JUSTID'],
127+
],
128+
'with all arguments' => [
129+
['key', 'group', 'consumer', 10000, '0-0', 10, true],
130+
['key', 'group', 'consumer', 10000, '0-0', 'COUNT', 10, 'JUSTID'],
131+
],
132+
];
133+
}
134+
}

0 commit comments

Comments
 (0)