Extended RedisJson support by implementing JSON.ARRINDEX command (#927)

* Added CommandResolver, moved resolve command logic there, added ClientConfiguration object

* Fixed test, added dependecies

* Added resolved command to commands array

* Used aggregation approach for modules

* Added decorator to check Redis JSON module version

* Added support for JSON.SET and JSON.GET commands

* Added separate workflow for redis-stack tests

* Changed docker imange name to correct one

* Fixed indentation

* Added test coverage for JSON.GET command

* Changed module version resolving using annotations mapping

* Re-written CommandResolver test

* Update ClientInterface.php

* Changes to CI, readme, removed unused modules from configuration

* Fixed build badge URL

* Refactored annotation check to be generic for each module

* Fixed bug with incorrect tests skip

* Added CommandResolver, moved resolve command logic there, added ClientConfiguration object

* Fixed test, added dependecies

* Added resolved command to commands array

* Used aggregation approach for modules

* Added decorator to check Redis JSON module version

* Added support for JSON.SET and JSON.GET commands

* Added separate workflow for redis-stack tests

* Changed docker imange name to correct one

* Fixed indentation

* Added test coverage for JSON.GET command

* Changed module version resolving using annotations mapping

* Re-written CommandResolver test

* Update ClientInterface.php

* Changes to CI, readme, removed unused modules from configuration

* Fixed build badge URL

* Refactored annotation check to be generic for each module

* Fixed bug with incorrect tests skip

* Fixed naming issue with nxXx argument

* Removed redundant trait

* Fixed NxXxArgument test

* Added support for JSON.ARRINDEX command

* Codestyle fies

Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>
Co-authored-by: Till Krüss <tillkruss@users.noreply.github.com>
This commit is contained in:
Vladyslav Vildanov
2023-01-26 16:17:47 +02:00
committed by GitHub
parent b9b312d94a
commit 1467c5bac0
4 changed files with 174 additions and 0 deletions
+1
View File
@@ -100,6 +100,7 @@ use Predis\Command\CommandInterface;
* @method $this hvals($key)
* @method $this hstrlen($key, $field)
* @method $this jsonarrappend(string $key, string $path = '$', ...$value)
* @method $this jsonarrindex(string $key, string $path, string $value, int $start = 0, int $stop = 0)
* @method $this jsondel(string $key, string $path = '$')
* @method $this jsonget(string $key, string $indent = '', string $newline = '', string $space = '', string ...$paths)
* @method $this jsonnumincrby(string $key, string $path, int $value)
+1
View File
@@ -109,6 +109,7 @@ use Predis\Response\Status;
* @method array hvals(string $key)
* @method int hstrlen(string $key, string $field)
* @method array jsonarrappend(string $key, string $path = '$', ...$value)
* @method array jsonarrindex(string $key, string $path, string $value, int $start = 0, int $stop = 0)
* @method int jsondel(string $key, string $path = '$')
* @method string jsonget(string $key, string $indent = '', string $newline = '', string $space = '', string ...$paths)
* @method string jsonnumincrby(string $key, string $path, int $value)
+28
View File
@@ -0,0 +1,28 @@
<?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\Json;
use Predis\Command\Command as RedisCommand;
/**
* @see https://redis.io/commands/json.arrindex/
*
* Search for the first occurrence of a JSON value in an array
*/
class JSONARRINDEX extends RedisCommand
{
public function getId()
{
return 'JSON.ARRINDEX';
}
}
@@ -0,0 +1,144 @@
<?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\Json;
use Predis\Command\Redis\PredisCommandTestCase;
class JSONARRINDEX_Test extends PredisCommandTestCase
{
/**
* {@inheritDoc}
*/
protected function getExpectedCommand(): string
{
return JSONARRINDEX::class;
}
/**
* {@inheritDoc}
*/
protected function getExpectedId(): string
{
return 'JSONARRINDEX';
}
/**
* @group disconnected
*/
public function testFilterArguments(): void
{
$arguments = ['key', '$..', 'value', 0, 0];
$expected = ['key', '$..', 'value', 0, 0];
$command = $this->getCommand();
$command->setArguments($arguments);
$this->assertSame($expected, $command->getArguments());
}
/**
* @group disconnected
*/
public function testParseResponse(): void
{
$this->assertSame(1, $this->getCommand()->parseResponse(1));
}
/**
* @group connected
* @dataProvider jsonProvider
* @param array $jsonArguments
* @param string $key
* @param string $path
* @param string $value
* @param int $start
* @param int $stop
* @param array $expectedIndices
* @return void
* @requiresRedisJsonVersion >= 1.0.0
*/
public function testReturnsCorrectJsonArrayIndex(
array $jsonArguments,
string $key,
string $path,
string $value,
int $start,
int $stop,
array $expectedIndices
): void {
$redis = $this->getClient();
$redis->jsonset(...$jsonArguments);
$this->assertSame($expectedIndices, $redis->jsonarrindex($key, $path, $value, $start, $stop));
}
public function jsonProvider(): array
{
return [
'on root level' => [
['key', '$', '{"key1":"value1","key2":["value1","value2"]}'],
'key',
'$.key2',
'"value2"',
0,
0,
[1],
],
'on nested level' => [
['key', '$', '{"key1":{"key2":["value1","value2"]}}'],
'key',
'$..key2',
'"value2"',
0,
0,
[1],
],
'with both level matching keys' => [
['key', '$', '{"key1":{"key2":["value1","value2"]},"key2":["value2"]}'],
'key',
'$..key2',
'"value2"',
0,
0,
[0, 1],
],
'with non-array path' => [
['key', '$', '{"key1":"value1","key2":"value2"}'],
'key',
'$.key2',
'"value2"',
0,
0,
[null],
],
'not found - limit by start and stop' => [
['key', '$', '{"key1":{"key2":["value1","value2"]},"key2":["value2"]}'],
'key',
'$..key2',
'"value2"',
0,
1,
[0, -1],
],
'not found - with wrong value' => [
['key', '$', '{"key1":{"key2":["value1","value2"]},"key2":["value2"]}'],
'key',
'$..key2',
'"value3"',
0,
0,
[-1, -1],
],
];
}
}