Extended core support by implementing FCALL_RO command (#1191)

examples/Commands/fcall_ro.php

@@ -0,0 +1,43 @@
+<?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.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of FCALL_RO command usage:
+
+// 1. Set key-value pair
+$client = new Client($single_server);
+$client->set('foo', 'bar');
+
+echo "Set key 'foo' with value 'bar'\n";
+
+// 2. Load redis function with 'no-writes' flag
+$client->function->load(
+    "#!lua name=mylib
+                redis.register_function{
+                    function_name='myfunc',
+                    callback=function(keys, args) return redis.call('GET', keys[1]) end,
+                    flags={'no-writes'}
+                }"
+);
+
+echo 'Loaded custom function that perform GET command against provided key.' . "\n";
+
+// 3. Call function above with given key
+$response = $client->fcall_ro('myfunc', ['foo']);
+
+echo "Function returned value against provided key 'foo' is '{$response}'";
+
+// 4. Delete test library
+$client->function->delete('mylib');

src/ClientContextInterface.php

@@ -57,6 +57,7 @@ use Predis\Command\Redis\Container\FunctionContainer;
  * @method $this decrby($key, $decrement)
  * @method $this failover(?To $to = null, bool $abort = false, int $timeout = -1)
  * @method $this fcall(string $function, array $keys, ...$args)
+ * @method $this fcall_ro(string $function, array $keys, ...$args)
  * @method $this get($key)
  * @method $this getbit($key, $offset)
  * @method $this getex(string $key, $modifier = '', $value = false)

src/ClientInterface.php

@@ -66,6 +66,7 @@ use Predis\Response\Status;
  * @method int               decrby(string $key, int $decrement)
  * @method Status            failover(?To $to = null, bool $abort = false, int $timeout = -1)
  * @method mixed             fcall(string $function, array $keys, ...$args)
+ * @method mixed             fcall_ro(string $function, array $keys, ...$args)
  * @method string|null       get(string $key)
  * @method int               getbit(string $key, $offset)
  * @method int|null          getex(string $key, $modifier = '', $value = false)

src/Command/Redis/FCALL_RO.php

@@ -0,0 +1,41 @@
+<?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\Redis;
+
+use Predis\Command\Command as RedisCommand;
+
+/**
+ * @see https://redis.io/commands/fcall_ro/
+ *
+ * This is a read-only variant of the FCALL command that cannot execute commands that modify data.
+ */
+class FCALL_RO extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FCALL_RO';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        $processedArguments = array_merge([$arguments[0], count($arguments[1])], $arguments[1]);
+
+        if (count($arguments) > 2) {
+            for ($i = 2, $iMax = count($arguments); $i < $iMax; $i++) {
+                $processedArguments[] = $arguments[$i];
+            }
+        }
+
+        parent::setArguments($processedArguments);
+    }
+}

tests/Predis/Command/Redis/FCALL_RO_Test.php

@@ -0,0 +1,141 @@
+<?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\Redis;
+
+use PHPUnit\Util\Test as TestUtil;
+use Predis\Response\ServerException;
+
+/**
+ * @group commands
+ * @group realm-scripting
+ */
+class FCALL_RO_Test extends PredisCommandTestCase
+{
+    private const LIB_NAME = 'mylib';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FCALL_RO::class;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FCALL_RO';
+    }
+
+    /**
+     * @group disconnected
+     * @dataProvider argumentsProvider
+     */
+    public function testFilterArguments(array $actualArguments, array $expectedArguments): void
+    {
+        $command = $this->getCommand();
+        $command->setArguments($actualArguments);
+
+        $this->assertSame($expectedArguments, $command->getArguments());
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testParseResponse(): void
+    {
+        $this->assertSame(1, $this->getCommand()->parseResponse(1));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRedisVersion >= 7.0.0
+     */
+    public function testInvokeGivenReadOnlyFunction(): void
+    {
+        $redis = $this->getClient();
+
+        $this->assertEquals('OK', $redis->set('key', 'value'));
+
+        $this->assertSame(
+            self::LIB_NAME,
+            $redis->function->load(
+                "#!lua name=mylib\n redis.register_function{function_name='myfunc',callback=function(keys, args) return redis.call('GET', keys[1]) end,flags={'no-writes'}}"
+            )
+        );
+
+        $actualResponse = $redis->fcall_ro('myfunc', ['key']);
+        $this->assertSame('value', $actualResponse);
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRedisVersion >= 7.0.0
+     */
+    public function testThrowsExceptionOnWriteContextFunction(): void
+    {
+        $redis = $this->getClient();
+
+        $this->assertEquals('OK', $redis->set('key', 'value'));
+
+        $this->assertSame(
+            self::LIB_NAME,
+            $redis->function->load(
+                "#!lua name=mylib \n redis.register_function('myfunc',function(keys, args) return redis.call('GET', keys[1]) end)"
+            )
+        );
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('ERR Can not execute a script with write flag using *_ro command.');
+
+        $redis->fcall_ro('myfunc', ['key']);
+    }
+
+    protected function tearDown(): void
+    {
+        $annotations = TestUtil::parseTestMethodAnnotations(
+            get_class($this),
+            $this->getName(false)
+        );
+
+        if (
+            isset($annotations['method']['group']) &&
+            in_array('connected', $annotations['method']['group'], true)
+        ) {
+            $redis = $this->getClient();
+            $redis->function->delete(self::LIB_NAME);
+        }
+    }
+
+    public function argumentsProvider(): array
+    {
+        return [
+            'with default arguments' => [
+                ['function', []],
+                ['function', 0],
+            ],
+            'with provided keys' => [
+                ['function', ['key1', 'key2']],
+                ['function', 2, 'key1', 'key2'],
+            ],
+            'with provided keys and arguments' => [
+                ['function', ['key1', 'key2'], 'arg1', 'arg2'],
+                ['function', 2, 'key1', 'key2', 'arg1', 'arg2'],
+            ],
+        ];
+    }
+}