Merge #253

253: Allow to use services for settings r=brunoocasali a=norkunas

# Pull Request

## Related issue
Fixes #248

## What does this PR do?
- Allows services to be used in index settings configuration and consumed on index create/import.

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Opened a a POC so we can discuss if this is the way to go :)

Things to notice:
 - We should probably split `CommandsTest` someday into multiple test files and use different config files, as now when you add a separate config for test most of tests output must also be updated.
 - Not validating the configuration schema properly is error prone. Had some hard times when just got `Meilisearch\Exceptions\ApiException: Json deserialize error: invalid type: map, expected a sequence at line 1 column 0` and how should I know which config setting is related? So imho we should properly validate all the settings for a better DX.

Co-authored-by: Tomas <norkunas.tom@gmail.com>

Author: meili-bors[bot]

src/Command/MeilisearchCreateCommand.php

@@ -9,6 +9,7 @@
 use Meilisearch\Bundle\Exception\TaskException;
 use Meilisearch\Bundle\Model\Aggregator;
 use Meilisearch\Bundle\SearchService;
+use Meilisearch\Bundle\SettingsProvider;
 use Meilisearch\Client;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -42,7 +43,7 @@ protected function configure(): void
             ->addOption('indices', 'i', InputOption::VALUE_OPTIONAL, 'Comma-separated list of index names');
     }
 
-    private function entitiesToIndex($indexes)
+    private function entitiesToIndex($indexes): array
     {
         foreach ($indexes as $key => $index) {
             $entityClassName = $index['class'];
@@ -85,16 +86,26 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 foreach ($index['settings'] as $variable => $value) {
                     $method = sprintf('update%s', ucfirst($variable));
 
-                    if (false === method_exists($indexInstance, $method)) {
+                    if (!method_exists($indexInstance, $method)) {
                         throw new InvalidSettingName(sprintf('Invalid setting name: "%s"', $variable));
                     }
 
+                    if (isset($value['_service']) && $value['_service'] instanceof SettingsProvider) {
+                        $value = $value['_service']();
+                    }
+
+                    // Update
                     $task = $indexInstance->{$method}($value);
+
+                    // Get task information using uid
+                    $indexInstance->waitForTask($task['taskUid']);
                     $task = $indexInstance->getTask($task['taskUid']);
 
                     if ('failed' === $task['status']) {
                         throw new TaskException($task['error']);
                     }
+
+                    $output->writeln('<info>Settings updated of "'.$index['name'].'".</info>');
                 }
             }
         }

src/Command/MeilisearchImportCommand.php

@@ -10,7 +10,9 @@
 use Meilisearch\Bundle\Exception\TaskException;
 use Meilisearch\Bundle\Model\Aggregator;
 use Meilisearch\Bundle\SearchService;
+use Meilisearch\Bundle\SettingsProvider;
 use Meilisearch\Client;
+use Meilisearch\Exceptions\TimeOutException;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -155,10 +157,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                     $indexInstance = $this->searchClient->index($index['name']);
                     foreach ($index['settings'] as $variable => $value) {
                         $method = sprintf('update%s', ucfirst($variable));
-                        if (false === method_exists($indexInstance, $method)) {
+
+                        if (!method_exists($indexInstance, $method)) {
                             throw new InvalidSettingName(sprintf('Invalid setting name: "%s"', $variable));
                         }
 
+                        if (isset($value['_service']) && $value['_service'] instanceof SettingsProvider) {
+                            $value = $value['_service']();
+                        }
+
                         // Update
                         $task = $indexInstance->{$method}($value);
 
@@ -168,9 +175,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
                         if ('failed' === $task['status']) {
                             throw new TaskException($task['error']);
-                        } else {
-                            $output->writeln('<info>Settings updated.</info>');
                         }
+
+                        $output->writeln('<info>Settings updated of "'.$index['name'].'".</info>');
                     }
                 }
 
@@ -185,7 +192,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return 0;
     }
 
-    /*
+    /**
      * @throws TimeOutException
      */
     private function formatIndexingResponse(array $batch, int $responseTimeout): array

src/DependencyInjection/MeilisearchExtension.php

@@ -31,6 +31,10 @@ public function load(array $configs, ContainerBuilder $container): void
             $config['prefix'] = $container->getParameter('kernel.environment').'_';
         }
 
+        foreach ($config['indices'] as $index => $indice) {
+            $config['indices'][$index]['settings'] = $this->findReferences($config['indices'][$index]['settings']);
+        }
+
         $container->setParameter('meili_url', $config['url'] ?? null);
         $container->setParameter('meili_api_key', $config['api_key'] ?? null);
         $container->setParameter('meili_symfony_version', MeilisearchBundle::qualifiedVersion());
@@ -55,4 +59,22 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $container->setDefinition('search.service', $searchDefinition->setPublic(true));
     }
+
+    /**
+     * @param array<mixed, mixed> $settings
+     *
+     * @return array<mixed, mixed>
+     */
+    private function findReferences(array $settings): array
+    {
+        foreach ($settings as $key => $value) {
+            if (is_array($value)) {
+                $settings[$key] = $this->findReferences($value);
+            } elseif ('_service' === substr((string) $key, -8) || str_starts_with((string) $value, '@') || 'service' === $key) {
+                $settings[$key] = new Reference(ltrim($value, '@'));
+            }
+        }
+
+        return $settings;
+    }
 }

src/SettingsProvider.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle;
+
+interface SettingsProvider
+{
+    /**
+     * @return array<mixed>
+     */
+    public function __invoke(): array;
+}

tests/Entity/DynamicSettings.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle\Tests\Entity;
+
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @ORM\Entity
+ */
+#[ORM\Entity]
+class DynamicSettings
+{
+    /**
+     * @ORM\Id
+     *
+     * @ORM\Column(type="integer")
+     */
+    #[ORM\Id]
+    #[ORM\Column(type: Types::INTEGER)]
+    private int $id;
+
+    /**
+     * @ORM\Column(type="string")
+     */
+    #[ORM\Column(type: Types::STRING)]
+    private string $name;
+
+    public function __construct(int $id, string $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}

tests/Integration/CommandsTest.php

@@ -6,6 +6,7 @@
 
 use Meilisearch\Bundle\Tests\BaseKernelTestCase;
 use Meilisearch\Bundle\Tests\Entity\DummyCustomGroups;
+use Meilisearch\Bundle\Tests\Entity\DynamicSettings;
 use Meilisearch\Bundle\Tests\Entity\SelfNormalizable;
 use Meilisearch\Client;
 use Meilisearch\Endpoints\Indexes;
@@ -77,9 +78,9 @@ public function testSearchImportAndClearAndDeleteWithoutIndices(): void
 Importing for index Meilisearch\Bundle\Tests\Entity\Post
 Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\Post entities into sf_phpunit__posts index (6 indexed since start)
 Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\Post entities into sf_phpunit__aggregated index (6 indexed since start)
-Settings updated.
-Settings updated.
-Settings updated.
+Settings updated of "sf_phpunit__posts".
+Settings updated of "sf_phpunit__posts".
+Settings updated of "sf_phpunit__posts".
 Importing for index Meilisearch\Bundle\Tests\Entity\Comment
 Importing for index Meilisearch\Bundle\Tests\Entity\Tag
 Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\Tag entities into sf_phpunit__tags index (6 indexed since start)
@@ -89,6 +90,11 @@ public function testSearchImportAndClearAndDeleteWithoutIndices(): void
 Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\Page entities into sf_phpunit__pages index (6 indexed since start)
 Importing for index Meilisearch\Bundle\Tests\Entity\SelfNormalizable
 Importing for index Meilisearch\Bundle\Tests\Entity\DummyCustomGroups
+Importing for index Meilisearch\Bundle\Tests\Entity\DynamicSettings
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
 Importing for index Meilisearch\Bundle\Tests\Entity\Post
 Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\Post entities into sf_phpunit__posts index (6 indexed since start)
 Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\Post entities into sf_phpunit__aggregated index (6 indexed since start)
@@ -114,6 +120,7 @@ public function testSearchImportAndClearAndDeleteWithoutIndices(): void
 Cleared sf_phpunit__pages index of Meilisearch\Bundle\Tests\Entity\Page
 Cleared sf_phpunit__self_normalizable index of Meilisearch\Bundle\Tests\Entity\SelfNormalizable
 Cleared sf_phpunit__dummy_custom_groups index of Meilisearch\Bundle\Tests\Entity\DummyCustomGroups
+Cleared sf_phpunit__dynamic_settings index of Meilisearch\Bundle\Tests\Entity\DynamicSettings
 Done!
 
 EOD, $clearOutput);
@@ -132,6 +139,7 @@ public function testSearchImportAndClearAndDeleteWithoutIndices(): void
 Deleted sf_phpunit__pages
 Deleted sf_phpunit__self_normalizable
 Deleted sf_phpunit__dummy_custom_groups
+Deleted sf_phpunit__dynamic_settings
 Done!
 
 EOD, $clearOutput);
@@ -325,12 +333,20 @@ public function testSearchCreateWithoutIndices(): void
 
         $this->assertSame(<<<'EOD'
 Creating index sf_phpunit__posts for Meilisearch\Bundle\Tests\Entity\Post
+Settings updated of "sf_phpunit__posts".
+Settings updated of "sf_phpunit__posts".
+Settings updated of "sf_phpunit__posts".
 Creating index sf_phpunit__comments for Meilisearch\Bundle\Tests\Entity\Comment
 Creating index sf_phpunit__tags for Meilisearch\Bundle\Tests\Entity\Tag
 Creating index sf_phpunit__tags for Meilisearch\Bundle\Tests\Entity\Link
 Creating index sf_phpunit__pages for Meilisearch\Bundle\Tests\Entity\Page
 Creating index sf_phpunit__self_normalizable for Meilisearch\Bundle\Tests\Entity\SelfNormalizable
 Creating index sf_phpunit__dummy_custom_groups for Meilisearch\Bundle\Tests\Entity\DummyCustomGroups
+Creating index sf_phpunit__dynamic_settings for Meilisearch\Bundle\Tests\Entity\DynamicSettings
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
 Creating index sf_phpunit__aggregated for Meilisearch\Bundle\Tests\Entity\Post
 Creating index sf_phpunit__aggregated for Meilisearch\Bundle\Tests\Entity\Tag
 Done!
@@ -350,6 +366,9 @@ public function testSearchCreateWithIndices(): void
 
         $this->assertSame(<<<'EOD'
 Creating index sf_phpunit__posts for Meilisearch\Bundle\Tests\Entity\Post
+Settings updated of "sf_phpunit__posts".
+Settings updated of "sf_phpunit__posts".
+Settings updated of "sf_phpunit__posts".
 Done!
 
 EOD, $createOutput);
@@ -437,4 +456,55 @@ public function testImportsDummyWithCustomGroups(): void
             ],
         ], $this->client->index('sf_phpunit__dummy_custom_groups')->getDocuments()->getResults());
     }
+
+    /**
+     * @testWith ["meili:create"]
+     *           ["meili:import"]
+     */
+    public function testImportWithDynamicSettings(string $command): void
+    {
+        for ($i = 0; $i <= 5; ++$i) {
+            $this->entityManager->persist(new DynamicSettings($i, "Dynamic $i"));
+        }
+
+        $this->entityManager->flush();
+
+        $importCommand = $this->application->find($command);
+        $importCommandTester = new CommandTester($importCommand);
+        $importCommandTester->execute(['--indices' => 'dynamic_settings']);
+
+        $importOutput = $importCommandTester->getDisplay();
+
+        if ('meili:import' === $command) {
+            $this->assertSame(<<<'EOD'
+Importing for index Meilisearch\Bundle\Tests\Entity\DynamicSettings
+Indexed a batch of 6 / 6 Meilisearch\Bundle\Tests\Entity\DynamicSettings entities into sf_phpunit__dynamic_settings index (6 indexed since start)
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Done!
+
+EOD, $importOutput);
+        } else {
+            $this->assertSame(<<<'EOD'
+Creating index sf_phpunit__dynamic_settings for Meilisearch\Bundle\Tests\Entity\DynamicSettings
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Settings updated of "sf_phpunit__dynamic_settings".
+Done!
+
+EOD, $importOutput);
+        }
+
+        $settings = $this->get('search.client')->index('sf_phpunit__dynamic_settings')->getSettings();
+
+        $getSetting = static fn ($value) => $value instanceof \IteratorAggregate ? iterator_to_array($value) : $value;
+
+        self::assertSame(['publishedAt', 'title'], $getSetting($settings['filterableAttributes']));
+        self::assertSame(['title'], $getSetting($settings['searchableAttributes']));
+        self::assertSame(['a', 'n', 'the'], $getSetting($settings['stopWords']));
+        self::assertSame(['fantastic' => ['great'], 'great' => ['fantastic']], $getSetting($settings['synonyms']));
+    }
 }

tests/Integration/Fixtures/FilterableAttributes.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle\Tests\Integration\Fixtures;
+
+use Meilisearch\Bundle\SettingsProvider;
+
+class FilterableAttributes implements SettingsProvider
+{
+    public function __invoke(): array
+    {
+        return ['title', 'publishedAt'];
+    }
+}

tests/Integration/Fixtures/SearchableAttributes.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle\Tests\Integration\Fixtures;
+
+use Meilisearch\Bundle\SettingsProvider;
+
+class SearchableAttributes implements SettingsProvider
+{
+    public function __invoke(): array
+    {
+        return ['title'];
+    }
+}

tests/Integration/Fixtures/StopWords.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle\Tests\Integration\Fixtures;
+
+use Meilisearch\Bundle\SettingsProvider;
+
+class StopWords implements SettingsProvider
+{
+    public function __invoke(): array
+    {
+        return ['the', 'a', 'n'];
+    }
+}

tests/Integration/Fixtures/Synonyms.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle\Tests\Integration\Fixtures;
+
+use Meilisearch\Bundle\SettingsProvider;
+
+class Synonyms implements SettingsProvider
+{
+    public function __invoke(): array
+    {
+        return [
+            'great' => ['fantastic'],
+            'fantastic' => ['great'],
+        ];
+    }
+}