From 34f40663ea4e8c2bcf19bc5159313da5ef26ada2 Mon Sep 17 00:00:00 2001 From: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com> Date: Thu, 26 Jan 2023 16:27:24 +0200 Subject: [PATCH] Extended RedisJson support by implementing JSON.ARRINSERT command (#929) 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.ARRINSERT command * Revert changes Co-authored-by: Vladyslav Vildanov Co-authored-by: Till Krüss --- src/ClientContextInterface.php | 1 + src/ClientInterface.php | 1 + src/Command/Redis/Json/JSONARRINSERT.php | 28 ++++ .../Command/Redis/Json/JSONARRINSERT_Test.php | 139 ++++++++++++++++++ 4 files changed, 169 insertions(+) create mode 100644 src/Command/Redis/Json/JSONARRINSERT.php create mode 100644 tests/Predis/Command/Redis/Json/JSONARRINSERT_Test.php diff --git a/src/ClientContextInterface.php b/src/ClientContextInterface.php index 6c62962f..9a6392f4 100644 --- a/src/ClientContextInterface.php +++ b/src/ClientContextInterface.php @@ -101,6 +101,7 @@ use Predis\Command\CommandInterface; * @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 jsonarrinsert(string $key, string $path, int $index, string ...$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) diff --git a/src/ClientInterface.php b/src/ClientInterface.php index 2495374b..c0fb85ed 100644 --- a/src/ClientInterface.php +++ b/src/ClientInterface.php @@ -110,6 +110,7 @@ use Predis\Response\Status; * @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 array jsonarrinsert(string $key, string $path, int $index, string ...$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) diff --git a/src/Command/Redis/Json/JSONARRINSERT.php b/src/Command/Redis/Json/JSONARRINSERT.php new file mode 100644 index 00000000..5e1ff251 --- /dev/null +++ b/src/Command/Redis/Json/JSONARRINSERT.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 $values + * @param array $expectedArrayLength + * @param string $expectedModifiedArray + * @return void + * @requiresRedisJsonVersion >= 1.0.0 + */ + public function testInsertElementIntoJsonArrayBeforeGivenIndex( + array $jsonArguments, + string $key, + string $path, + int $index, + array $values, + array $expectedArrayLength, + string $expectedModifiedArray + ): void { + $redis = $this->getClient(); + + $redis->jsonset(...$jsonArguments); + + $actualResponse = $redis->jsonarrinsert($key, $path, $index, ...$values); + + $this->assertSame($expectedArrayLength, $actualResponse); + $this->assertSame($expectedModifiedArray, $redis->jsonget($key)); + } + + public function jsonProvider(): array + { + return [ + 'on root level' => [ + ['key', '$', '{"key1":"value1","key2":["value1","value3"]}'], + 'key', + '$.key2', + 1, + ['"value2"'], + [3], + '{"key1":"value1","key2":["value1","value2","value3"]}', + ], + 'on nested level' => [ + ['key', '$', '{"key1":{"key2":["value1","value3"]}}'], + 'key', + '$..key2', + 1, + ['"value2"'], + [3], + '{"key1":{"key2":["value1","value2","value3"]}}', + ], + 'with both levels matching keys' => [ + ['key', '$', '{"key1":{"key2":["value1","value3"]},"key2":["value1","value3"]}'], + 'key', + '$..key2', + 1, + ['"value2"'], + [3, 3], + '{"key1":{"key2":["value1","value2","value3"]},"key2":["value1","value2","value3"]}', + ], + 'with multiple values inserted' => [ + ['key', '$', '{"key1":"value1","key2":["value1","value4"]}'], + 'key', + '$.key2', + 1, + ['"value2"', '"value3"'], + [4], + '{"key1":"value1","key2":["value1","value2","value3","value4"]}', + ], + 'with non-array path' => [ + ['key', '$', '{"key1":"value1","key2":"value2"}'], + 'key', + '$.key2', + 1, + ['"value2"'], + [null], + '{"key1":"value1","key2":"value2"}', + ], + ]; + } +}