mirror of
https://github.com/predis/predis.git
synced 2026-08-18 12:11:46 +00:00
Extended Json support by implementing JSON.DEBUG command (#1182)
* Added support for new arguments for BITPOS, BITCOUNT commands (#1045) * Added support for new arguments for EXPIRE, EXPIREAT commands (#1046) * Extended core support by implementing SORT_RO command (#1044) * Added support for SORT_RO command * Codestyle fixes * Added command description --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * fix deprecated call * Added support for container commands (#1049) * Added support for container commands FUNCTION LOAD, FUNCTION DELETE and FCALL * Changed ContainerInterface and AbstractContainer * Re-implement logic of abstract methods --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * Added stream commands to KeyPrefixProcessor (#1051) Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * Fix return type of ReplicationInterface::getSlaves (#1111) * Codestyle fixes * Changed return annotation * Added support for JSON.DEBUG command * Codestyle fixes --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> Co-authored-by: Till Krüss <till@kruss.io> Co-authored-by: Stephan <glaubinix@users.noreply.github.com>
This commit is contained in:
Vladyslav Vildanov
committed by
GitHub
GitHub
parent
de8147a0d3
commit
a93e1e5a99
@@ -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.
|
||||
*/
|
||||
|
||||
use Predis\Client;
|
||||
|
||||
require __DIR__ . '/../../shared.php';
|
||||
|
||||
// Example of JSON.DEBUG command usage:
|
||||
|
||||
// 1. Set JSON object
|
||||
$client = new Client();
|
||||
|
||||
$client->jsonset('key', '$', '{"key1":"value1","key2":"value2"}');
|
||||
|
||||
// 2. Dump information about json memory usage in bytes
|
||||
$response = $client->jsondebug->memory('key', '$');
|
||||
|
||||
echo 'Response:' . "\n";
|
||||
print_r($response);
|
||||
@@ -26,6 +26,7 @@ use Predis\Command\Argument\Server\LimitOffsetCount;
|
||||
use Predis\Command\Argument\Server\To;
|
||||
use Predis\Command\CommandInterface;
|
||||
use Predis\Command\Container\FUNCTIONS;
|
||||
use Predis\Command\Container\Json\JSONDEBUG;
|
||||
use Predis\Command\Container\Search\FTCONFIG;
|
||||
|
||||
/**
|
||||
@@ -299,6 +300,7 @@ use Predis\Command\Container\Search\FTCONFIG;
|
||||
* Container commands
|
||||
* @property FUNCTIONS $function
|
||||
* @property FTCONFIG $ftconfig
|
||||
* @property JSONDEBUG $jsondebug
|
||||
*/
|
||||
interface ClientContextInterface
|
||||
{
|
||||
|
||||
@@ -26,6 +26,7 @@ use Predis\Command\Argument\Server\LimitOffsetCount;
|
||||
use Predis\Command\Argument\Server\To;
|
||||
use Predis\Command\CommandInterface;
|
||||
use Predis\Command\Container\FUNCTIONS;
|
||||
use Predis\Command\Container\Json\JSONDEBUG;
|
||||
use Predis\Command\Container\Search\FTCONFIG;
|
||||
use Predis\Command\FactoryInterface;
|
||||
use Predis\Configuration\OptionsInterface;
|
||||
@@ -317,6 +318,7 @@ use Predis\Response\Status;
|
||||
* Container commands
|
||||
* @property FUNCTIONS $function
|
||||
* @property FTCONFIG $ftconfig
|
||||
* @property JSONDEBUG $jsondebug
|
||||
*/
|
||||
interface ClientInterface
|
||||
{
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
<?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\Container\Json;
|
||||
|
||||
use Predis\Command\Container\AbstractContainer;
|
||||
|
||||
/**
|
||||
* @method array memory(string $key, string $path)
|
||||
* @method array help()
|
||||
*/
|
||||
class JSONDEBUG extends AbstractContainer
|
||||
{
|
||||
public function getContainerCommandId(): string
|
||||
{
|
||||
return 'JSONDEBUG';
|
||||
}
|
||||
}
|
||||
@@ -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.debug/
|
||||
*
|
||||
* This is a container command for debugging related tasks.
|
||||
*/
|
||||
class JSONDEBUG extends RedisCommand
|
||||
{
|
||||
public function getId()
|
||||
{
|
||||
return 'JSON.DEBUG';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,130 @@
|
||||
<?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 JSONDEBUG_Test extends PredisCommandTestCase
|
||||
{
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedCommand(): string
|
||||
{
|
||||
return JSONDEBUG::class;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
protected function getExpectedId(): string
|
||||
{
|
||||
return 'JSONDEBUG';
|
||||
}
|
||||
|
||||
/**
|
||||
* @group disconnected
|
||||
*/
|
||||
public function testFilterArguments(): void
|
||||
{
|
||||
$arguments = ['MEMORY', 'key', '$'];
|
||||
$expected = ['MEMORY', '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 $expectedMemoryUsage
|
||||
* @return void
|
||||
* @requiresRedisJsonVersion >= 1.0.0
|
||||
*/
|
||||
public function testMemoryReturnsCorrectMemoryUsageAboutJson(
|
||||
array $jsonArguments,
|
||||
string $key,
|
||||
string $path,
|
||||
array $expectedMemoryUsage
|
||||
): void {
|
||||
$redis = $this->getClient();
|
||||
|
||||
$redis->jsonset(...$jsonArguments);
|
||||
|
||||
$this->assertSame($expectedMemoryUsage, $redis->jsondebug->memory($key, $path));
|
||||
}
|
||||
|
||||
/**
|
||||
* @group connected
|
||||
* @return void
|
||||
* @requiresRedisJsonVersion >= 1.0.0
|
||||
*/
|
||||
public function testHelpReturnsInformationAboutContainerCommands(): void
|
||||
{
|
||||
$redis = $this->getClient();
|
||||
|
||||
$actualResponse = $redis->jsondebug->help();
|
||||
|
||||
$this->assertStringContainsString('MEMORY', $actualResponse[0]);
|
||||
$this->assertStringContainsString('HELP', $actualResponse[1]);
|
||||
}
|
||||
|
||||
public function jsonProvider(): array
|
||||
{
|
||||
return [
|
||||
'on root level' => [
|
||||
['key', '$', '{"key1":"value1","key2":"value2"}'],
|
||||
'key',
|
||||
'$',
|
||||
[44],
|
||||
],
|
||||
'on nested level' => [
|
||||
['key', '$', '{"key1":{"key2":"value2"}}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
[14],
|
||||
],
|
||||
'with same keys on both levels' => [
|
||||
['key', '$', '{"key1":{"key2":"value2"},"key2":"value2"}'],
|
||||
'key',
|
||||
'$..key2',
|
||||
[14, 14],
|
||||
],
|
||||
'with wrong key' => [
|
||||
['key', '$', '{"key1":{"key2":"value2"}}'],
|
||||
'key1',
|
||||
'$',
|
||||
[],
|
||||
],
|
||||
'with wrong path' => [
|
||||
['key', '$', '{"key1":{"key2":"value2"}}'],
|
||||
'key',
|
||||
'$.key3',
|
||||
[],
|
||||
],
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user