geckon01/predis
1
0
Fork 0
mirror of https://github.com/predis/predis.git synced 2026-08-30 12:15:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added commands support (#1108)

Browse Source 
Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>
This commit is contained in:
Vladyslav Vildanov
2023-02-08 10:24:36 +02:00
committed by GitHub
parent 12673ef50a
commit 13e687a1fa
6 changed files with 365 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ClientContextInterface.php
+2
View File
@@ -186,7 +186,9 @@ use Predis\Command\CommandInterface;
* @method $this tdigestreset(string $key)
* @method $this tdigestrevrank(string $key, float ...$value)
* @method $this tdigesttrimmed_mean(string $key, float $lowCutQuantile, float $highCutQuantile)
* @method $this topkadd(string $key, ...$items)
* @method $this topkinfo(string $key)
* @method $this topklist(string $key, bool $withCount = false)
* @method $this topkreserve(string $key, int $topK, int $width = 8, int $depth = 7, float $decay = 0.9)
* @method $this zadd($key, array $membersAndScoresDictionary)
* @method $this zcard($key)
src/ClientInterface.php
+2
View File
@@ -196,7 +196,9 @@ use Predis\Response\Status;
* @method Status tdigestreset(string $key)
* @method array tdigestrevrank(string $key, float ...$value)
* @method string tdigesttrimmed_mean(string $key, float $lowCutQuantile, float $highCutQuantile)
* @method array topkadd(string $key, ...$items)
* @method array topkinfo(string $key)
* @method array topklist(string $key, bool $withCount = false)
* @method Status topkreserve(string $key, int $topK, int $width = 8, int $depth = 7, float $decay = 0.9)
* @method string xadd(string $key, array $dictionary, string $id = '*', array $options = null)
* @method int xdel(string $key, string ...$id)
src/Command/Redis/TopK/TOPKADD.php
+31
View File
@@ -0,0 +1,31 @@
<?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\TopK;
use Predis\Command\Command as RedisCommand;
/**
* @see https://redis.io/commands/topk.add/
*
* Adds an item to the data structure.
* Multiple items can be added at once.
* If an item enters the Top-K list, the item which is expelled is returned.
* This allows dynamic heavy-hitter detection of items being entered or expelled from Top-K list.
*/
class TOPKADD extends RedisCommand
{
public function getId()
{
return 'TOPK.ADD';
}
}
src/Command/Redis/TopK/TOPKLIST.php
+68
View File
@@ -0,0 +1,68 @@
<?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\TopK;
use Predis\Command\Command as RedisCommand;
/**
* @see https://redis.io/commands/topk.list/
*
* Return full list of items in Top K list.
*/
class TOPKLIST extends RedisCommand
{
public function getId()
{
return 'TOPK.LIST';
}
public function setArguments(array $arguments)
{
if (!empty($arguments[1])) {
$arguments[1] = 'WITHCOUNT';
}
parent::setArguments($arguments);
$this->filterArguments();
}
public function parseResponse($data)
{
if ($this->isWithCountModifier()) {
$result = [];
for ($i = 0, $iMax = count($data); $i < $iMax; ++$i) {
if (array_key_exists($i + 1, $data)) {
$result[(string) $data[$i]] = $data[++$i];
}
}
return $result;
}
return $data;
}
/**
* Checks for the presence of the WITHCOUNT modifier.
*
* @return bool
*/
private function isWithCountModifier(): bool
{
$arguments = $this->getArguments();
$lastArgument = (!empty($arguments)) ? $arguments[count($arguments) - 1] : null;
return is_string($lastArgument) && strtoupper($lastArgument) === 'WITHCOUNT';
}
}
tests/Predis/Command/Redis/TopK/TOPKADD_Test.php
+110
View File
@@ -0,0 +1,110 @@
<?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\TopK;
use Predis\Command\Redis\PredisCommandTestCase;
use Predis\Response\ServerException;
class TOPKADD_Test extends PredisCommandTestCase
{
/**
* {@inheritDoc}
*/
protected function getExpectedCommand(): string
{
return TOPKADD::class;
}
/**
* {@inheritDoc}
*/
protected function getExpectedId(): string
{
return 'TOPKADD';
}
/**
* @group disconnected
*/
public function testFilterArguments(): void
{
$actualArguments = ['key', 'item1', 'item2'];
$expectedArguments = ['key', 'item1', 'item2'];
$command = $this->getCommand();
$command->setArguments($actualArguments);
$this->assertSameValues($expectedArguments, $command->getArguments());
}
/**
* @group disconnected
*/
public function testParseResponse(): void
{
$this->assertSame(1, $this->getCommand()->parseResponse(1));
}
/**
* @group connected
* @dataProvider structuresProvider
* @param array $reserveArguments
* @param array $addArguments
* @param array $expectedResponse
* @return void
* @requiresRedisBfVersion >= 2.0.0
*/
public function testAddItemsIntoGivenTopKStructure(
array $reserveArguments,
array $addArguments,
array $expectedResponse
): void {
$redis = $this->getClient();
$redis->topkreserve(...$reserveArguments);
$actualResponse = $redis->topkadd(...$addArguments);
$this->assertEquals($expectedResponse, $actualResponse);
}
/**
* @group connected
* @return void
* @requiresRedisBfVersion >= 2.0.0
*/
public function testThrowsExceptionOnNonExistingKey(): void
{
$redis = $this->getClient();
$this->expectException(ServerException::class);
$this->expectExceptionMessage('TopK: key does not exist');
$redis->topkadd('key', 0, 1);
}
public function structuresProvider(): array
{
return [
'without dropped items' => [
['key', 4],
['key', 0, 1, 2],
[null, null, null],
],
'with dropped items' => [
['key', 2],
['key', 0, 1, 2],
[null, null, '0'],
],
];
}
}
tests/Predis/Command/Redis/TopK/TOPKLIST_Test.php
+152
View File
@@ -0,0 +1,152 @@
<?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\TopK;
use Predis\Command\Redis\PredisCommandTestCase;
use Predis\Response\ServerException;
class TOPKLIST_Test extends PredisCommandTestCase
{
/**
* {@inheritDoc}
*/
protected function getExpectedCommand(): string
{
return TOPKLIST::class;
}
/**
* {@inheritDoc}
*/
protected function getExpectedId(): string
{
return 'TOPKLIST';
}
/**
* @group disconnected
* @dataProvider argumentsProvider
*/
public function testFilterArguments(array $actualArguments, array $expectedArguments): void
{
$command = $this->getCommand();
$command->setArguments($actualArguments);
$this->assertSameValues($expectedArguments, $command->getArguments());
}
/**
* @group disconnected
* @dataProvider responsesProvider
*/
public function testParseResponse(array $arguments, array $actualResponse, array $expectedResponse): void
{
$command = $this->getCommand();
$command->setArguments($arguments);
$this->assertSame($expectedResponse, $command->parseResponse($actualResponse));
}
/**
* @group connected
* @dataProvider structureProvider
* @param array $reserveArguments
* @param array $addArguments
* @param array $listArguments
* @param array $expectedResponse
* @return void
* @requiresRedisBfVersion >= 2.0.0
*/
public function testReturnsListOfItemsWithinTopKStructure(
array $reserveArguments,
array $addArguments,
array $listArguments,
array $expectedResponse
): void {
$redis = $this->getClient();
$redis->topkreserve(...$reserveArguments);
$redis->topkadd(...$addArguments);
$actualResponse = $redis->topklist(...$listArguments);
$this->assertEquals($expectedResponse, $actualResponse);
}
/**
* @group connected
* @return void
* @requiresRedisBfVersion >= 2.0.0
*/
public function testThrowsExceptionOnNonExistingKey(): void
{
$redis = $this->getClient();
$this->expectException(ServerException::class);
$this->expectExceptionMessage('TopK: key does not exist');
$redis->topklist('key', true);
}
public function argumentsProvider(): array
{
return [
'with default argument' => [
['key'],
['key'],
],
'with WITHCOUNT modifier equals true' => [
['key', true],
['key', 'WITHCOUNT'],
],
'with WITHCOUNT modifier equals false' => [
['key', false],
['key'],
],
];
}
public function responsesProvider(): array
{
return [
'without WITHCOUNT modifier' => [
['foo'],
['foo', 'bar'],
['foo', 'bar'],
],
'with WITHCOUNT modifier' => [
['foo', true],
['foo', 12, 'bar', 13],
['foo' => 12, 'bar' => 13],
],
];
}
public function structureProvider(): array
{
return [
'with default arguments' => [
['key', 50],
['key', 1, 2, 2, 3, 3, 3],
['key', false],
['3', '2', '1'],
],
'with WITHCOUNT modifier' => [
['key', 50],
['key', 1, 2, 2, 3, 3, 3],
['key', true],
['3' => 3, '2' => 2, '1' => 1],
],
];
}
}