Added support for TOPK.QUERY command (#1110)

Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>

src/ClientContextInterface.php

@@ -190,6 +190,7 @@ use Predis\Command\CommandInterface;
  * @method $this topkincrby(string $key, ...$itemIncrement)
  * @method $this topkinfo(string $key)
  * @method $this topklist(string $key, bool $withCount = false)
+ * @method $this topkquery(string $key, ...$items)
  * @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

@@ -200,6 +200,7 @@ use Predis\Response\Status;
  * @method array             topkincrby(string $key, ...$itemIncrement)
  * @method array             topkinfo(string $key)
  * @method array             topklist(string $key, bool $withCount = false)
+ * @method array             topkquery(string $key, ...$items)
  * @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/TOPKQUERY.php

@@ -0,0 +1,29 @@
+<?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.query/
+ *
+ * Checks whether an item is one of Top-K items.
+ * Multiple items can be checked at once.
+ */
+class TOPKQUERY extends RedisCommand
+{
+    public function getId()
+    {
+        return 'TOPK.QUERY';
+    }
+}

tests/Predis/Command/Redis/TopK/TOPKQUERY_Test.php

@@ -0,0 +1,87 @@
+<?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 TOPKQUERY_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return TOPKQUERY::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'TOPKQUERY';
+    }
+
+    /**
+     * @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
+     * @return void
+     * @requiresRedisBfVersion >= 2.0.0
+     */
+    public function testQueryChecksIfItemExistsWithinGivenTopKStructure(): void
+    {
+        $redis = $this->getClient();
+
+        $redis->topkreserve('key', 50);
+        $redis->topkadd('key', 'item1');
+
+        $this->assertSame([1, 0], $redis->topkquery('key', 'item1', 'item2'));
+    }
+
+    /**
+     * @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->topkquery('key', 0, 1);
+    }
+}