Skip to content

Commit d607123

Browse files
vladvildanovvladvildanov
committed
Merge branch 'vv-937-acl-dryrun-command' of github.com:vladvildanov/predis into vv-937-acl-dryrun-command
2 parents 551e3e7 + b8a2d65 commit d607123

File tree

6 files changed

+228
-1
lines changed

6 files changed

+228
-1
lines changed

‎examples/Commands/fcall_ro.php

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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+
use Predis\Client;
14+
15+
require __DIR__ . '/../shared.php';
16+
17+
// Example of FCALL_RO command usage:
18+
19+
// 1. Set key-value pair
20+
$client = new Client($single_server);
21+
$client->set('foo', 'bar');
22+
23+
echo "Set key 'foo' with value 'bar'\n";
24+
25+
// 2. Load redis function with 'no-writes' flag
26+
$client->function->load(
27+
"#!lua name=mylib
28+
redis.register_function{
29+
function_name='myfunc',
30+
callback=function(keys, args) return redis.call('GET', keys[1]) end,
31+
flags={'no-writes'}
32+
}"
33+
);
34+
35+
echo 'Loaded custom function that perform GET command against provided key.' . "\n";
36+
37+
// 3. Call function above with given key
38+
$response = $client->fcall_ro('myfunc', ['foo']);
39+
40+
echo "Function returned value against provided key 'foo' is '{$response}'";
41+
42+
// 4. Delete test library
43+
$client->function->delete('mylib');

‎src/ClientContextInterface.php

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
* @method $this decrby($key, $decrement)
5959
* @method $this failover(?To $to = null, bool $abort = false, int $timeout = -1)
6060
* @method $this fcall(string $function, array $keys, ...$args)
61+
* @method $this fcall_ro(string $function, array $keys, ...$args)
6162
* @method $this get($key)
6263
* @method $this getbit($key, $offset)
6364
* @method $this getex(string $key, $modifier = '', $value = false)

‎src/ClientInterface.php

+1
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
* @method int decrby(string $key, int $decrement)
6868
* @method Status failover(?To $to = null, bool $abort = false, int $timeout = -1)
6969
* @method mixed fcall(string $function, array $keys, ...$args)
70+
* @method mixed fcall_ro(string $function, array $keys, ...$args)
7071
* @method string|null get(string $key)
7172
* @method int getbit(string $key, $offset)
7273
* @method int|null getex(string $key, $modifier = '', $value = false)

‎src/Command/Redis/FCALL_RO.php

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
/**
18+
* @see https://redis.io/commands/fcall_ro/
19+
*
20+
* This is a read-only variant of the FCALL command that cannot execute commands that modify data.
21+
*/
22+
class FCALL_RO extends RedisCommand
23+
{
24+
public function getId()
25+
{
26+
return 'FCALL_RO';
27+
}
28+
29+
public function setArguments(array $arguments)
30+
{
31+
$processedArguments = array_merge([$arguments[0], count($arguments[1])], $arguments[1]);
32+
33+
if (count($arguments) > 2) {
34+
for ($i = 2, $iMax = count($arguments); $i < $iMax; $i++) {
35+
$processedArguments[] = $arguments[$i];
36+
}
37+
}
38+
39+
parent::setArguments($processedArguments);
40+
}
41+
}

‎src/Configuration/Option/Connections.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public function filter(OptionsInterface $options, $value)
5757
* The factory instance is configured according to the supplied named array
5858
* mapping URI schemes (passed as keys) to the FCQN of classes implementing
5959
* Predis\Connection\NodeConnectionInterface, or callable objects acting as
60-
* lazy initalizers and returning new instances of classes implementing
60+
* lazy initializers and returning new instances of classes implementing
6161
* Predis\Connection\NodeConnectionInterface.
6262
*
6363
* @param OptionsInterface $options Client options

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

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
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 PHPUnit\Util\Test as TestUtil;
16+
use Predis\Response\ServerException;
17+
18+
/**
19+
* @group commands
20+
* @group realm-scripting
21+
*/
22+
class FCALL_RO_Test extends PredisCommandTestCase
23+
{
24+
private const LIB_NAME = 'mylib';
25+
26+
/**
27+
* {@inheritdoc}
28+
*/
29+
protected function getExpectedCommand(): string
30+
{
31+
return FCALL_RO::class;
32+
}
33+
34+
/**
35+
* {@inheritdoc}
36+
*/
37+
protected function getExpectedId(): string
38+
{
39+
return 'FCALL_RO';
40+
}
41+
42+
/**
43+
* @group disconnected
44+
* @dataProvider argumentsProvider
45+
*/
46+
public function testFilterArguments(array $actualArguments, array $expectedArguments): void
47+
{
48+
$command = $this->getCommand();
49+
$command->setArguments($actualArguments);
50+
51+
$this->assertSame($expectedArguments, $command->getArguments());
52+
}
53+
54+
/**
55+
* @group disconnected
56+
*/
57+
public function testParseResponse(): void
58+
{
59+
$this->assertSame(1, $this->getCommand()->parseResponse(1));
60+
}
61+
62+
/**
63+
* @group connected
64+
* @return void
65+
* @requiresRedisVersion >= 7.0.0
66+
*/
67+
public function testInvokeGivenReadOnlyFunction(): void
68+
{
69+
$redis = $this->getClient();
70+
71+
$this->assertEquals('OK', $redis->set('key', 'value'));
72+
73+
$this->assertSame(
74+
self::LIB_NAME,
75+
$redis->function->load(
76+
"#!lua name=mylib\n redis.register_function{function_name='myfunc',callback=function(keys, args) return redis.call('GET', keys[1]) end,flags={'no-writes'}}"
77+
)
78+
);
79+
80+
$actualResponse = $redis->fcall_ro('myfunc', ['key']);
81+
$this->assertSame('value', $actualResponse);
82+
}
83+
84+
/**
85+
* @group connected
86+
* @return void
87+
* @requiresRedisVersion >= 7.0.0
88+
*/
89+
public function testThrowsExceptionOnWriteContextFunction(): void
90+
{
91+
$redis = $this->getClient();
92+
93+
$this->assertEquals('OK', $redis->set('key', 'value'));
94+
95+
$this->assertSame(
96+
self::LIB_NAME,
97+
$redis->function->load(
98+
"#!lua name=mylib \n redis.register_function('myfunc',function(keys, args) return redis.call('GET', keys[1]) end)"
99+
)
100+
);
101+
102+
$this->expectException(ServerException::class);
103+
$this->expectExceptionMessage('ERR Can not execute a script with write flag using *_ro command.');
104+
105+
$redis->fcall_ro('myfunc', ['key']);
106+
}
107+
108+
protected function tearDown(): void
109+
{
110+
$annotations = TestUtil::parseTestMethodAnnotations(
111+
get_class($this),
112+
$this->getName(false)
113+
);
114+
115+
if (
116+
isset($annotations['method']['group']) &&
117+
in_array('connected', $annotations['method']['group'], true)
118+
) {
119+
$redis = $this->getClient();
120+
$redis->function->delete(self::LIB_NAME);
121+
}
122+
}
123+
124+
public function argumentsProvider(): array
125+
{
126+
return [
127+
'with default arguments' => [
128+
['function', []],
129+
['function', 0],
130+
],
131+
'with provided keys' => [
132+
['function', ['key1', 'key2']],
133+
['function', 2, 'key1', 'key2'],
134+
],
135+
'with provided keys and arguments' => [
136+
['function', ['key1', 'key2'], 'arg1', 'arg2'],
137+
['function', 2, 'key1', 'key2', 'arg1', 'arg2'],
138+
],
139+
];
140+
}
141+
}

0 commit comments

Comments
 (0)