Extended RediSearch support by implementing FT.SYNDUMP command (#1165)

* add support for CF.ADDNX

* fix key name

* fix wrong command

* Pulling changes

* Added support for FT.CREATE command

* Fixed tests to choose correct DB

* Added test coverage

* Revert changes for missing commands

* Added data types enums, added methods default assignments

* Fixed vector field, removed default assignments, fixed tests

* Added constants enum for Sortable argument, renamed arguments object

* Codestyle fixes

* Rename test class

* Added support for FT.SYNUPDATE command

* Added support for FT.SYNDUMP command

* Fixed order number

---------

Co-authored-by: shacharPash <shachar.pashchur@redis.com>
Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>

examples/Commands/Search/ft_syndump.php

@@ -0,0 +1,34 @@
+<?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;
+use Predis\Command\Argument\Search\Schema;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of FT.SYNDUMP command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = new Schema();
+$schema->addTextField('text_field');
+$client->ftcreate('index_syndump', $schema);
+
+// 2. Add synonyms group with terms
+$client->ftsynupdate('index_syndump', 'synonym1', null, 'term1', 'term2');
+
+// 3. Dump terms with synonyms
+$response = $client->ftsyndump('index_syndump');
+
+echo 'Response:' . "\n";
+print_r($response);

src/ClientContextInterface.php

@@ -102,6 +102,7 @@ use Predis\Command\Redis\Container\FUNCTIONS;
  * @method $this ftprofile(string $index, ProfileArguments $arguments)
  * @method $this ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method $this ftspellcheck(string $index, string $query, ?SearchArguments $arguments = null)
+ * @method $this ftsyndump(string $index)
  * @method $this ftsynupdate(string $index, string $synonymGroupId, ?SynUpdateArguments $arguments = null, string ...$terms)
  * @method $this get($key)
  * @method $this getbit($key, $offset)

src/ClientInterface.php

@@ -111,6 +111,7 @@ use Predis\Response\Status;
  * @method array             ftprofile(string $index, ProfileArguments $arguments)
  * @method array             ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method array             ftspellcheck(string $index, string $query, ?SearchArguments $arguments = null)
+ * @method array             ftsyndump(string $index)
  * @method Status            ftsynupdate(string $index, string $synonymGroupId, ?SynUpdateArguments $arguments = null, string ...$terms)
  * @method string|null       get(string $key)
  * @method int               getbit(string $key, $offset)

src/Command/Redis/Search/FTSYNDUMP.php

@@ -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\Search;
+
+use Predis\Command\Command as RedisCommand;
+
+/**
+ * @see https://redis.io/commands/ft.syndump/
+ *
+ * Dump the contents of a synonym group.
+ */
+class FTSYNDUMP extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.SYNDUMP';
+    }
+}

tests/Predis/Command/Redis/Search/FTSYNDUMP_Test.php

@@ -0,0 +1,100 @@
+<?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\Search;
+
+use Predis\Command\Argument\Search\Schema;
+use Predis\Command\Redis\PredisCommandTestCase;
+use Predis\Response\ServerException;
+
+/**
+ * @group commands
+ * @group realm-stack
+ */
+class FTSYNDUMP_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTSYNDUMP::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTSYNDUMP';
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testFilterArguments(): void
+    {
+        $actualArguments = ['index'];
+        $expectedArguments = ['index'];
+
+        $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
+     * @requiresRediSearchVersion >= 1.2.0
+     */
+    public function testDumpReturnsContentOfSynonymGroupFromGivenIndex(): void
+    {
+        $redis = $this->getClient();
+        $expectedResponse = ['term1', ['synonym1'], 'term2', ['synonym1']];
+
+        $this->assertEquals(
+            'OK',
+            $redis->ftcreate('index', (new Schema())->addTextField('text_field'))
+        );
+
+        $this->assertEquals(
+            'OK',
+            $redis->ftsynupdate('index', 'synonym1', null, 'term1', 'term2')
+        );
+
+        $this->assertSame($expectedResponse, $redis->ftsyndump('index'));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRediSearchVersion >= 1.2.0
+     */
+    public function testThrowsExceptionOnNonExistingIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('Unknown index name');
+
+        $redis->ftsyndump('index');
+    }
+}

tests/Predis/Command/Redis/Search/FTSYNUPDATE_Test.php

@@ -17,6 +17,10 @@ use Predis\Command\Argument\Search\SynUpdateArguments;
 use Predis\Command\Redis\PredisCommandTestCase;
 use Predis\Response\ServerException;
 
+/**
+ * @group commands
+ * @group realm-stack
+ */
 class FTSYNUPDATE_Test extends PredisCommandTestCase
 {
     /**