Extended RediSearch support by implementing FT.ALTER command (#1153)

* 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 support for FT.ALTER command

* Added constants enum for Sortable argument, renamed arguments object

* Codestyle fixes

* Rename test class

* Added example, changed command arguments interface

* Updated example

---------

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

examples/Commands/Search/ft_alter.php

@@ -0,0 +1,39 @@
+<?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.ALTER command usage:
+
+// 1. Create index
+$client = new Client();
+
+$schema = new Schema();
+$schema->addTextField('text_field');
+$client->ftcreate('index_alter', $schema);
+
+echo 'Default index attributes:' . "\n";
+$defaultAttributes = $client->ftinfo('index_alter');
+print_r($defaultAttributes[7]);
+
+// 2. Add additional attribute to existing index
+$schema = new Schema(true);
+$schema->addTextField('new_field_name');
+
+$client->ftalter('index_alter', $schema);
+
+echo 'Updated index attributes:' . "\n";
+$updatedAttributes = $client->ftinfo('index_alter');
+print_r($updatedAttributes[7]);

src/ClientContextInterface.php

@@ -14,6 +14,7 @@ namespace Predis;
 
 use Predis\Command\Argument\Geospatial\ByInterface;
 use Predis\Command\Argument\Geospatial\FromInterface;
+use Predis\Command\Argument\Search\AlterArguments;
 use Predis\Command\Argument\Search\CreateArguments;
 use Predis\Command\Argument\Search\DropArguments;
 use Predis\Command\Argument\Search\ProfileArguments;
@@ -93,6 +94,7 @@ use Predis\Command\Redis\Container\FUNCTIONS;
  * @method $this ftaliasadd(string $alias, string $index)
  * @method $this ftaliasdel(string $alias)
  * @method $this ftaliasupdate(string $alias, string $index)
+ * @method $this ftalter(string $index, Schema $schema, ?AlterArguments $arguments = null)
  * @method $this ftcreate(string $index, Schema $schema, ?CreateArguments $arguments = null)
  * @method $this ftdictadd(string $dict, ...$term)
  * @method $this ftdictdel(string $dict, ...$term)

src/ClientInterface.php

@@ -14,6 +14,7 @@ namespace Predis;
 
 use Predis\Command\Argument\Geospatial\ByInterface;
 use Predis\Command\Argument\Geospatial\FromInterface;
+use Predis\Command\Argument\Search\AlterArguments;
 use Predis\Command\Argument\Search\CreateArguments;
 use Predis\Command\Argument\Search\DropArguments;
 use Predis\Command\Argument\Search\ProfileArguments;
@@ -102,6 +103,7 @@ use Predis\Response\Status;
  * @method Status            ftaliasadd(string $alias, string $index)
  * @method Status            ftaliasdel(string $alias)
  * @method Status            ftaliasupdate(string $alias, string $index)
+ * @method Status            ftalter(string $index, Schema $schema, ?AlterArguments $arguments = null)
  * @method Status            ftcreate(string $index, Schema $schema, ?CreateArguments $arguments = null)
  * @method int               ftdictadd(string $dict, ...$term)
  * @method int               ftdictdel(string $dict, ...$term)

src/Command/Argument/Search/AlterArguments.php

@@ -0,0 +1,17 @@
+<?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\Argument\Search;
+
+class AlterArguments extends CommonArguments
+{
+}

src/Command/Argument/Search/Schema.php

@@ -25,6 +25,16 @@ class Schema implements ArrayableArgument
      */
     private $arguments = ['SCHEMA'];
 
+    /**
+     * @param bool $additive Defines if schema should be additive, for additional attributes
+     */
+    public function __construct(bool $additive = false)
+    {
+        if ($additive) {
+            $this->arguments[] = 'ADD';
+        }
+    }
+
     /**
      * Adds text field to schema configuration.
      *

src/Command/Redis/Search/FTALTER.php

@@ -0,0 +1,39 @@
+<?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;
+
+class FTALTER extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.ALTER';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        [$index, $schema] = $arguments;
+        $commandArguments = [];
+
+        if (!empty($arguments[2])) {
+            $commandArguments = $arguments[2]->toArray();
+        }
+
+        parent::setArguments(array_merge(
+            [$index],
+            $commandArguments,
+            $schema->toArray()
+        ));
+    }
+}

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

@@ -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\Search;
+
+use Predis\Command\Argument\Search\AlterArguments;
+use Predis\Command\Argument\Search\Schema;
+use Predis\Command\Redis\PredisCommandTestCase;
+use Predis\Response\ServerException;
+
+/**
+ * @group commands
+ * @group realm-stack
+ */
+class FTALTER_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTALTER::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTALTER';
+    }
+
+    /**
+     * @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
+     */
+    public function testParseResponse(): void
+    {
+        $this->assertSame(1, $this->getCommand()->parseResponse(1));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRediSearchVersion >= 1.0.0
+     */
+    public function testAddsAttributeToExistingIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $schema = new Schema();
+        $schema->addTextField('field_name');
+
+        $this->assertEquals('OK', $redis->ftcreate('index', $schema));
+
+        $schema = new Schema(true);
+        $schema->addTextField('new_field_name');
+
+        $this->assertEquals('OK', $redis->ftalter('index', $schema));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRediSearchVersion >= 1.0.0
+     */
+    public function testThrowsExceptionOnNonExistingIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('Unknown index name');
+
+        $redis->ftalter('alias', (new Schema())->addTextField('field_name'));
+    }
+
+    public function argumentsProvider(): array
+    {
+        return [
+            'with default arguments' => [
+                ['index', (new Schema(true))->addTextField('text_field')],
+                ['index', 'SCHEMA', 'ADD', 'text_field', 'TEXT'],
+            ],
+            'with SKIPINITIALSCAN modifier' => [
+                ['index', (new Schema(true))->addTextField('text_field'), (new AlterArguments())->skipInitialScan()],
+                ['index', 'SKIPINITIALSCAN', 'SCHEMA', 'ADD', 'text_field', 'TEXT'],
+            ],
+        ];
+    }
+}