mirror of
https://github.com/predis/predis.git
synced 2026-08-30 12:15:03 +00:00
Extended RedisJson support by implementing JSON.ARRAPPEND command (#924)
* 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.ARRAPPEND command 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
committed by
GitHub
GitHub
parent
1ee196134e
commit
b9b312d94a
@@ -99,6 +99,7 @@ use Predis\Command\CommandInterface;
|
||||
* @method $this hsetnx($key, $field, $value)
|
||||
* @method $this hvals($key)
|
||||
* @method $this hstrlen($key, $field)
|
||||
* @method $this jsonarrappend(string $key, string $path = '$', ...$value)
|
||||
* @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)
|
||||
|
||||
@@ -108,6 +108,7 @@ use Predis\Response\Status;
|
||||
* @method int hsetnx(string $key, string $field, string $value)
|
||||
* @method array hvals(string $key)
|
||||
* @method int hstrlen(string $key, string $field)
|
||||
* @method array jsonarrappend(string $key, string $path = '$', ...$value)
|
||||
* @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)
|
||||
|
||||
@@ -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.arrappend/
|
||||
*
|
||||
* Append the json values into the array at path after the last element in it
|
||||
*/
|
||||
class JSONARRAPPEND extends RedisCommand
|
||||
{
|
||||
public function getId()
|
||||
{
|
||||
return 'JSON.ARRAPPEND';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
<?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 JSONARRAPPEND_Test extends PredisCommandTestCase
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedCommand(): string
|
||||
{
|
||||
return JSONARRAPPEND::class;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedId(): string
|
||||
{
|
||||
return 'JSONARRAPPEND';
|
||||
}
|
||||
|
||||
/**
|
||||
* @group disconnected
|
||||
*/
|
||||
public function testFilterArguments(): void
|
||||
{
|
||||
$arguments = ['key', '$..', 5, 'value'];
|
||||
$expected = ['key', '$..', 5, 'value'];
|
||||
|
||||
$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 array $values
|
||||
* @param array $expectedArrayLength
|
||||
* @param string $expectedModifiedJson
|
||||
* @return void
|
||||
* @requiresRedisJsonVersion >= 1.0.0
|
||||
*/
|
||||
public function testAppendItemsToGivenJsonArray(
|
||||
array $jsonArguments,
|
||||
string $key,
|
||||
string $path,
|
||||
array $values,
|
||||
array $expectedArrayLength,
|
||||
string $expectedModifiedJson
|
||||
): void {
|
||||
$redis = $this->getClient();
|
||||
|
||||
$redis->jsonset(...$jsonArguments);
|
||||
|
||||
$actualResponse = $redis->jsonarrappend($key, $path, ...$values);
|
||||
|
||||
$this->assertSame($expectedArrayLength, $actualResponse);
|
||||
$this->assertSame($expectedModifiedJson, $redis->jsonget($key));
|
||||
}
|
||||
|
||||
public function jsonProvider(): array
|
||||
{
|
||||
return [
|
||||
'append single item' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
['"value3"'],
|
||||
[3],
|
||||
'{"key1":"value1","key2":["value1","value2","value3"]}',
|
||||
],
|
||||
'append multiple items - same type' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
['"value3"', '"value4"'],
|
||||
[4],
|
||||
'{"key1":"value1","key2":["value1","value2","value3","value4"]}',
|
||||
],
|
||||
'append multiple items - different types' => [
|
||||
['key', '$', '{"key1":"value1","key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$.key2',
|
||||
['"value3"', '5'],
|
||||
[4],
|
||||
'{"key1":"value1","key2":["value1","value2","value3",5]}',
|
||||
],
|
||||
'append on root and nested level' => [
|
||||
['key', '$', '{"key1":{"key2":["value1","value2"]},"key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
['"value3"', '5'],
|
||||
[4, 4],
|
||||
'{"key1":{"key2":["value1","value2","value3",5]},"key2":["value1","value2","value3",5]}',
|
||||
],
|
||||
'append on root and nested level - not array key' => [
|
||||
['key', '$', '{"key1":{"key2":"value2"},"key2":["value1","value2"]}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
['"value3"', '5'],
|
||||
[4, null],
|
||||
'{"key1":{"key2":"value2"},"key2":["value1","value2","value3",5]}',
|
||||
],
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user