Extended RedisJson support by implementing JSON.RESP command (#1006)

* 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.RESP command

* Removed debugger

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 17:19:11 +02:00
committed by GitHub
parent 9a7490e3af
commit e29ee802d6
4 changed files with 152 additions and 0 deletions
+1
View File
@@ -112,6 +112,7 @@ use Predis\Command\CommandInterface;
* @method $this jsonmget(array $keys, string $path)
* @method $this jsonobjkeys(string $key, string $path = '$')
* @method $this jsonobjlen(string $key, string $path = '$')
* @method $this jsonresp(string $key, string $path = '$')
* @method $this jsonset(string $key, string $path, string $value, ?string $subcommand = null)
* @method $this jsonstrappend(string $key, string $path, string $value)
* @method $this jsonstrlen(string $key, string $path = '$')
+1
View File
@@ -121,6 +121,7 @@ use Predis\Response\Status;
* @method array jsonmget(array $keys, string $path)
* @method array jsonobjkeys(string $key, string $path = '$')
* @method array jsonobjlen(string $key, string $path = '$')
* @method array jsonresp(string $key, string $path = '$')
* @method string jsonset(string $key, string $path, string $value, ?string $subcommand = null)
* @method array jsonstrappend(string $key, string $path, string $value)
* @method array jsonstrlen(string $key, string $path = '$')
+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.resp/
*
* Return the JSON in key in Redis serialization protocol specification form
*/
class JSONRESP extends RedisCommand
{
public function getId()
{
return 'JSON.RESP';
}
}
@@ -0,0 +1,122 @@
<?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;
use Predis\Response\Status;
class JSONRESP_Test extends PredisCommandTestCase
{
/**
* {@inheritDoc}
*/
protected function getExpectedCommand(): string
{
return JSONRESP::class;
}
/**
* {@inheritDoc}
*/
protected function getExpectedId(): string
{
return 'JSONRESP';
}
/**
* @group disconnected
*/
public function testFilterArguments(): void
{
$arguments = ['key', '$..'];
$expected = ['key', '$..'];
$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 $expectedResponse
* @return void
* @requiresRedisJsonVersion >= 1.0.0
*/
public function testReturnRespValueFromGivenJson(
array $jsonArguments,
string $key,
string $path,
array $expectedResponse
): void {
$redis = $this->getClient();
$redis->jsonset(...$jsonArguments);
$this->assertEquals($expectedResponse, $redis->jsonresp($key, $path));
}
public function jsonProvider(): array
{
return [
'with string value' => [
['key', '$', '{"key1":"value1"}'],
'key',
'$.key1',
['value1'],
],
'with numeric value' => [
['key', '$', '{"key1":1}'],
'key',
'$.key1',
[1],
],
'with array value' => [
['key', '$', '{"key1":[1,2,3]}'],
'key',
'$.key1',
[[new Status('['), 1, 2, 3]],
],
'with json object value' => [
['key', '$', '{"key1":{"key2":"value2"}}'],
'key',
'$.key1',
[[new Status('{'), 'key2', 'value2']],
],
'with boolean value' => [
['key', '$', '{"key1":true}'],
'key',
'$.key1',
['true'],
],
'with null value' => [
['key', '$', '{"key1":null}'],
'key',
'$.key1',
[null],
],
];
}
}