From 653d62ab409395170ca87fba9585f5e04729bcaf Mon Sep 17 00:00:00 2001 From: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com> Date: Thu, 26 Jan 2023 16:42:12 +0200 Subject: [PATCH] Extended RedisJson support by implementing JSON.ARRPOP command (#933) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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.ARRPOP command Co-authored-by: Vladyslav Vildanov Co-authored-by: Till Krüss --- src/ClientContextInterface.php | 1 + src/ClientInterface.php | 1 + src/Command/Redis/Json/JSONARRPOP.php | 28 ++++ .../Command/Redis/Json/JSONARRPOP_Test.php | 123 ++++++++++++++++++ 4 files changed, 153 insertions(+) create mode 100644 src/Command/Redis/Json/JSONARRPOP.php create mode 100644 tests/Predis/Command/Redis/Json/JSONARRPOP_Test.php diff --git a/src/ClientContextInterface.php b/src/ClientContextInterface.php index af4dfd0e..f68ad04d 100644 --- a/src/ClientContextInterface.php +++ b/src/ClientContextInterface.php @@ -103,6 +103,7 @@ use Predis\Command\CommandInterface; * @method $this jsonarrindex(string $key, string $path, string $value, int $start = 0, int $stop = 0) * @method $this jsonarrinsert(string $key, string $path, int $index, string ...$value) * @method $this jsonarrlen(string $key, string $path = '$') + * @method $this jsonarrpop(string $key, string $path = '$', int $index = -1) * @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) diff --git a/src/ClientInterface.php b/src/ClientInterface.php index e7680ad9..782b6472 100644 --- a/src/ClientInterface.php +++ b/src/ClientInterface.php @@ -112,6 +112,7 @@ use Predis\Response\Status; * @method array jsonarrindex(string $key, string $path, string $value, int $start = 0, int $stop = 0) * @method array jsonarrinsert(string $key, string $path, int $index, string ...$value) * @method array jsonarrlen(string $key, string $path = '$') + * @method array jsonarrpop(string $key, string $path = '$', int $index = -1) * @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) diff --git a/src/Command/Redis/Json/JSONARRPOP.php b/src/Command/Redis/Json/JSONARRPOP.php new file mode 100644 index 00000000..a8e239b9 --- /dev/null +++ b/src/Command/Redis/Json/JSONARRPOP.php @@ -0,0 +1,28 @@ +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 int $index + * @param array $expectedPoppedElements + * @param string $expectedModifiedJson + * @return void + * @requiresRedisJsonVersion >= 1.0.0 + */ + public function testRemovesElementFromIndexOfJsonArray( + array $jsonArguments, + string $key, + string $path, + int $index, + array $expectedPoppedElements, + string $expectedModifiedJson + ): void { + $redis = $this->getClient(); + + $redis->jsonset(...$jsonArguments); + $actualResponse = $redis->jsonarrpop($key, $path, $index); + + $this->assertSame($expectedPoppedElements, $actualResponse); + $this->assertSame($expectedModifiedJson, $redis->jsonget($key)); + } + + public function jsonProvider(): array + { + return [ + 'removes last element' => [ + ['key', '$', '{"key1":"value1","key2":["value1","value2"]}'], + 'key', + '$.key2', + -1, + ['"value2"'], + '{"key1":"value1","key2":["value1"]}', + ], + 'removes i-element' => [ + ['key', '$', '{"key1":"value1","key2":["value1","value2"]}'], + 'key', + '$.key2', + 0, + ['"value1"'], + '{"key1":"value1","key2":["value2"]}', + ], + 'removes elements from root and nested levels' => [ + ['key', '$', '{"key1":{"key2":["value1","value2"]},"key2":["value1","value2"]}'], + 'key', + '$..key2', + -1, + ['"value2"', '"value2"'], + '{"key1":{"key2":["value1"]},"key2":["value1"]}', + ], + 'removes element from non-array' => [ + ['key', '$', '{"key1":"value1","key2":"value2"}'], + 'key', + '$.key2', + -1, + [null], + '{"key1":"value1","key2":"value2"}', + ], + ]; + } +}