Merge #370

370:  Use VariableNode on "settings" configuration r=norkunas a=pan93412

# Pull Request

## Related issue
Fixes #369

## What does this PR do?

"arrayNode" does not support arbitrary configuration keys. Therefore, I switch to variableNode with dynamic check.

## 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?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Yi-Jyun Pan <[email protected]>

Author: meili-bors[bot]

src/DependencyInjection/Configuration.php

@@ -7,6 +7,7 @@
 use Meilisearch\Bundle\Searchable;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 
 final class Configuration implements ConfigurationInterface
 {
@@ -62,11 +63,20 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->info('Property accessor path (like method or property name) used to decide if an entry should be indexed.')
                                 ->defaultNull()
                             ->end()
-                            ->arrayNode('settings')
+                            ->variableNode('settings')
+                                ->defaultValue([])
                                 ->info('Configure indices settings, see: https://www.meilisearch.com/docs/reference/api/settings')
                                 ->beforeNormalization()
                                     ->always()
-                                    ->then(static function (array $value) {
+                                    ->then(static function ($value) {
+                                        if (null === $value) {
+                                            return [];
+                                        }
+
+                                        if (!\is_array($value)) {
+                                            throw new InvalidConfigurationException('Settings must be an array.');
+                                        }
+
                                         $stringSettings = ['distinctAttribute', 'proximityPrecision', 'searchCutoffMs'];
 
                                         foreach ($stringSettings as $setting) {
@@ -77,9 +87,7 @@ public function getConfigTreeBuilder(): TreeBuilder
 
                                         return $value;
                                     })
-                                ->end()
-                                ->arrayPrototype()
-                                    ->variablePrototype()->end()
+                                    ->end()
                                 ->end()
                             ->end()
                         ->end()

tests/Unit/ConfigurationTest.php

@@ -23,6 +23,46 @@ public function testValidConfig(array $inputConfig, array $expectedConfig): void
         $this->assertProcessedConfigurationEquals($inputConfig, $expectedConfig);
     }
 
+    /**
+     * @param mixed $value
+     *
+     * @dataProvider dataTestSettingsDynamicCheckerInvalid
+     */
+    public function testSettingsDynamicCheckerInvalid($value): void
+    {
+        $this->assertConfigurationIsInvalid([
+            'meilisearch' => [
+                'indices' => [
+                    [
+                        'name' => 'items',
+                        'class' => 'App\Entity\Post',
+                        'settings' => $value,
+                    ],
+                ],
+            ],
+        ], 'Settings must be an array.');
+    }
+
+    /**
+     * @param mixed $value
+     *
+     * @dataProvider dataTestSettingsDynamicCheckerValid
+     */
+    public function testSettingsDynamicCheckerValid($value): void
+    {
+        $this->assertConfigurationIsValid([
+            'meilisearch' => [
+                'indices' => [
+                    [
+                        'name' => 'items',
+                        'class' => 'App\Entity\Post',
+                        'settings' => $value,
+                    ],
+                ],
+            ],
+        ]);
+    }
+
     /**
      * @return iterable<array{inputConfig: array<mixed>, expectedConfig: array<mixed>}>
      */
@@ -294,6 +334,41 @@ public static function dataTestConfigurationTree(): iterable
         ];
     }
 
+    /**
+     * @return iterable<array{value: mixed}>
+     */
+    public static function dataTestSettingsDynamicCheckerInvalid(): iterable
+    {
+        yield 'string is not acceptable' => [
+            'value' => 'hello',
+        ];
+        yield 'int is not acceptable' => [
+            'value' => 1,
+        ];
+        yield 'bool is not acceptable' => [
+            'value' => true,
+        ];
+    }
+
+    /**
+     * @return iterable<array{value: mixed}>
+     */
+    public static function dataTestSettingsDynamicCheckerValid(): iterable
+    {
+        yield 'array is acceptable' => [
+            'value' => [],
+        ];
+        yield 'array with arbitrary key is acceptable' => [
+            'value' => [
+                'key' => 'value',
+                'key2' => 'value2',
+            ],
+        ];
+        yield 'null is acceptable' => [
+            'value' => null,
+        ];
+    }
+
     protected function getConfiguration(): Configuration
     {
         return new Configuration();