handle string/array for SLM indices

Author: stephanediondev

src/Form/Type/ElasticsearchSlmPolicyType.php

@@ -102,13 +102,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                     ]);
                     break;
                 case 'indices':
-                    $builder->add('indices', ChoiceType::class, [
-                        'multiple' => true,
-                        'choices' => $options['indices'],
-                        'choice_label' => static function ($choice, $key, $value) use ($options) {
-                            return $options['indices'][$key];
-                        },
-                        'choice_translation_domain' => false,
+                    $builder->add('indices', TextType::class, [
                         'label' => 'indices',
                         'required' => false,
                         'attr' => [

src/Model/ElasticsearchSlmPolicyModel.php

@@ -14,10 +14,7 @@ class ElasticsearchSlmPolicyModel extends AbstractAppModel
 
     private ?string $repository = null;
 
-    /**
-     * @var array<mixed>|null $indices
-     */
-    private ?array $indices = null;
+    private ?string $indices = null;
 
     private ?string $schedule = null;
 
@@ -97,24 +94,23 @@ public function setRepository(?string $repository): self
         return $this;
     }
 
-    /**
-     * @return array<mixed>|null
-     */
-    public function getIndices(): ?array
+    public function getIndices(): ?string
     {
         return $this->indices;
     }
 
-    /**
-     * @param array<mixed>|null $indices
-     */
-    public function setIndices(?array $indices): self
+    public function setIndices(?string $indices): self
     {
         $this->indices = $indices;
 
         return $this;
     }
 
+    public function getIndicesToArray(): array
+    {
+        return explode(',', $this->indices);
+    }
+
     public function getSchedule(): ?string
     {
         return $this->schedule;
@@ -346,7 +342,11 @@ public function convert(?array $policy): self
         }
 
         if (true === isset($policy['policy']['config']['indices'])) {
-            $this->setIndices($policy['policy']['config']['indices']);
+            $indices = $policy['policy']['config']['indices'];
+            if (true === is_array($indices)) {
+                $indices = implode(',', $indices);
+            }
+            $this->setIndices($indices);
         }
 
         if (true === isset($policy['policy']['retention']['expire_after'])) {
@@ -412,7 +412,7 @@ public function getJson(): array
         ];
 
         if ($this->getIndices()) {
-            $json['config']['indices'] = $this->getIndices();
+            $json['config']['indices'] = $this->getIndicesToArray();
         } else {
             $json['config']['indices'] = ['*'];
         }

templates/Modules/slm/slm_read.html.twig

@@ -90,7 +90,7 @@
                 {{ appImport.dashboardKpi({'title': 'include_global_state'|trans, 'badge': {'title': ('boolean.' ~ policy.includeGlobalState)|trans, 'context': policy.includeGlobalState}}) }}
             </div>
 
-            {% if 0 < policy.indices|length %}
+            {% if 0 < policy.indicesToArray|length %}
                 {% embed 'Embed/table_embed.html.twig' %}
                     {% import 'Import/app_import.html.twig' as appImport %}
 
@@ -101,7 +101,7 @@
                     {% endblock %}
 
                     {% block tbody %}
-                        {% for index in policy.indices %}
+                        {% for index in policy.indicesToArray %}
                             <tr>
                                 <td>{{ index }}</td>
                             </tr>

tests/Model/ElasticsearchSlmPolicyModelTest.php

@@ -20,7 +20,7 @@ public function test(): void
         $policy->setPartial(true);
         $policy->setIncludeGlobalState(true);
 
-        $policy->setIndices(['indices']);
+        $policy->setIndices('indices');
         $policy->setLastSuccess(['lastsuccess']);
         $policy->setLastFailure(['lastfailure']);
         $policy->setStats(['stats']);
@@ -56,8 +56,7 @@ public function test(): void
         $this->assertEquals($policy->getIncludeGlobalState(), true);
         $this->assertIsBool($policy->getIncludeGlobalState());
 
-        $this->assertEquals($policy->getIndices(), ['indices']);
-        $this->assertIsArray($policy->getIndices());
+        $this->assertEquals($policy->getIndices(), 'indices');
 
         $this->assertEquals($policy->getLastSuccess(), ['lastsuccess']);
         $this->assertIsArray($policy->getLastSuccess());

translations/messages.en.yaml

@@ -339,7 +339,7 @@ help_form:
         name: "A unique identifier for this policy."
         snapshot_name: "The name for the snapshots. A unique identifier is automatically added to each name. Supports <a class=\"text-light\" rel=\"noreferrer\" target=\"_blank\" href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/date-math-index-names.html#date-math-index-names\">date math expressions</a>."
         repository: "The repository where you want to store the snapshots."
-        indices: "Indices to back up."
+        indices: "Indices to back up (separated by commas)."
         schedule: "The frequency at which to take the snapshots. Use <a class=\"text-light\" rel=\"noreferrer\" target=\"_blank\" href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/trigger-schedule.html#schedule-cron\">cron expression</a>."
         expire_after: "The time to wait before deleting snapshots."
         min_count: "The minimum number of snapshots to store in your cluster."