Merge pull request #1962 from mwoynarski/bugfix/index_patterns

Updated index template feature to be compatible with ES 6.x+

Author: XWB

doc/templates.md

@@ -18,7 +18,7 @@ fos_elastica:
         <name>:
             client: default
             template_name: <template name>
-            template: some_index_*
+            index_patterns: ["some_index_*", "some_other_index_*"]
             settings:
                 number_of_shards: 1
                 number_of_replicas: 0
@@ -32,7 +32,7 @@ fos_elastica:
 Index template is similar to index configuration and has the same fields like `settings`, `client`, etc. with additional fields:
 
 1. `template_name` - template name. If omitted then used key (`<name>`) of `index_templates` section. Example: `template_1`
-2. `template` - template pattern. Example: `te*` or `bar*`
+2. `index_patterns` - index pattern(s) on which to apply the template. Example: `te*` or `bar*`
 
 To apply templates changes, you should run `fos:elastica:reset-templates` command:
 

src/Configuration/IndexConfigInterface.php

@@ -28,7 +28,7 @@
  *     config: TElasticConfig,
  *     mapping: TMapping,
  *     model: mixed,
- *     template?: string,
+ *     index_patterns?: array,
  * }
  * @phpstan-type TElasticConfig = array{
  *     date_detection?: bool,

src/Configuration/IndexTemplateConfig.php

@@ -25,9 +25,9 @@ class IndexTemplateConfig implements IndexConfigInterface
     /**
      * Index name pattern.
      *
-     * @var string
+     * @var array<string>
      */
-    private $template;
+    private array $indexPatterns;
 
     /**
      * Constructor expects an array as generated by the Container Configuration builder.
@@ -45,18 +45,18 @@ public function __construct(array $config)
         // @phpstan-ignore-next-line Ignored because of a bug in PHPStan (https://github.com/phpstan/phpstan/issues/5091)
         $this->mapping = $config['mapping'];
 
-        if (!isset($config['template'])) {
-            throw new \InvalidArgumentException('Index template value must be set');
+        if (empty($config['index_patterns'])) {
+            throw new \InvalidArgumentException("Property 'index_patterns' must be set for index template {$this->name}");
         }
 
-        $this->template = $config['template'];
+        $this->indexPatterns = $config['index_patterns'];
     }
 
     /**
      * Gets index name pattern.
      */
-    public function getTemplate(): string
+    public function getIndexPatterns(): array
     {
-        return $this->template;
+        return $this->indexPatterns;
     }
 }

src/DependencyInjection/Configuration.php

@@ -519,7 +519,8 @@ private function addIndexTemplatesSection(ArrayNodeDefinition $rootNode)
                             ->scalarNode('template_name')
                                 ->info('Defaults to the name of the index template, but can be modified if the index name is different in ElasticSearch')
                             ->end()
-                            ->scalarNode('template')->isRequired()->end()
+                            ->scalarNode('template')->end()
+                            ->arrayNode('index_patterns')->prototype('scalar')->end()->end()
                             ->scalarNode('client')->end()
                             ->variableNode('settings')->defaultValue([])->end()
                             ->booleanNode('date_detection')->end()

src/DependencyInjection/FOSElasticaExtension.php

@@ -269,6 +269,10 @@ private function loadIndexTemplates(array $indexTemplates, ContainerBuilder $con
             $indexId = \sprintf('fos_elastica.index_template.%s', $name);
             $indexTemplateName = $indexTemplate['template_name'] ?? $name;
 
+            if (empty($indexTemplate['index_patterns']) && empty($indexTemplate['template'])) {
+                throw new \InvalidArgumentException("One of 'template', 'index_patterns' must be provided for index template {$indexTemplateName}");
+            }
+
             $indexDef = new ChildDefinition('fos_elastica.index_template_prototype');
             $indexDef->setFactory([new Reference('fos_elastica.client'), 'getIndexTemplate']);
             $indexDef->replaceArgument(0, $indexTemplateName);
@@ -289,7 +293,7 @@ private function loadIndexTemplates(array $indexTemplates, ContainerBuilder $con
                 'reference' => $reference,
                 'name' => $name,
                 'settings' => $indexTemplate['settings'],
-                'template' => $indexTemplate['template'],
+                'index_patterns' => !empty($indexTemplate['index_patterns']) ? $indexTemplate['index_patterns'] : [$indexTemplate['template']],
             ];
 
             $this->loadIndexConfig((array) $indexTemplate, $this->indexTemplateConfigs[$name]);

src/Index/MappingBuilder.php

@@ -57,12 +57,12 @@ public function buildIndexMapping(IndexConfigInterface $indexConfig): array
     /**
      * Builds mappings for an entire index template.
      *
-     * @return array{mappings: TMapping, settings: TSettings, template: string}
+     * @return array{mappings: TMapping, settings: TSettings, index_patterns: array<string>}
      */
     public function buildIndexTemplateMapping(IndexTemplateConfig $indexTemplateConfig): array
     {
         $mapping = $this->buildIndexMapping($indexTemplateConfig);
-        $mapping['template'] = $indexTemplateConfig->getTemplate();
+        $mapping['index_patterns'] = $indexTemplateConfig->getIndexPatterns();
 
         return $mapping;
     }

src/Index/TemplateResetter.php

@@ -67,6 +67,8 @@ public function resetIndex(string $indexName, bool $deleteIndexes = false): void
      */
     public function deleteTemplateIndexes(IndexTemplateConfig $template): void
     {
-        $this->client->request($template->getTemplate().'/', Request::DELETE);
+        foreach ($template->getIndexPatterns() as $pattern) {
+            $this->client->request($pattern.'/', Request::DELETE);
+        }
     }
 }

tests/Unit/Configuration/IndexTemplateConfigTest.php

@@ -26,7 +26,7 @@ public function testInstantiate()
             'elasticsearch_name' => 'index_template_elastic_name1',
             'name' => 'index_template1',
             'settings' => [1],
-            'template' => 't*',
+            'index_patterns' => ['t*'],
             'config' => [],
             'mapping' => [],
         ];
@@ -38,7 +38,7 @@ public function testInstantiate()
                 'elasticsearch_name' => $indexTemplate->getElasticSearchName(),
                 'name' => $indexTemplate->getName(),
                 'settings' => $indexTemplate->getSettings(),
-                'template' => $indexTemplate->getTemplate(),
+                'index_patterns' => $indexTemplate->getIndexPatterns(),
                 'config' => [],
                 'mapping' => [],
             ]

tests/Unit/Configuration/Source/TemplateContainerSourceTest.php

@@ -45,15 +45,15 @@ public function testGetConfiguration()
                     'settings' => [
                         'some_setting' => 'setting_value',
                     ],
-                    'template' => 'some_index_config_*',
+                    'index_patterns' => ['some_index_config_*'],
                 ],
             ]
         );
         $indexes = $containerSource->getConfiguration();
         $this->assertInstanceOf(IndexTemplateConfig::class, $indexes['some_index_template']);
         $templateConfig = $indexes['some_index_template'];
         $this->assertEquals('some_index_template', $templateConfig->getName());
-        $this->assertEquals('some_index_config_*', $templateConfig->getTemplate());
+        $this->assertEquals(['some_index_config_*'], $templateConfig->getIndexPatterns());
         $this->assertEquals(
             [
                 'some_setting' => 'setting_value',

tests/Unit/Index/MappingBuilderTest.php

@@ -97,11 +97,11 @@ public function testMappingBuilderStoreProperty()
     public function testBuildIndexTemplateMapping()
     {
         $config = new IndexTemplateConfig(
-            ['template' => 'index_template_*', 'name' => 'some_template', 'config' => [], 'mapping' => $this->indexConfig->getMapping()]
+            ['index_patterns' => ['index_template_*'], 'name' => 'some_template', 'config' => [], 'mapping' => $this->indexConfig->getMapping()]
         );
         $this->assertEquals(
             [
-                'template' => 'index_template_*',
+                'index_patterns' => ['index_template_*'],
                 'mappings' => $this->indexConfig->getMapping(),
             ],
             $this->builder->buildIndexTemplateMapping($config)