Merge pull request #155 from delyriand/fix/153-add-prefix-option

Add prefix option for names of indexes and aliases

Author: maximehuran

Makefile

@@ -202,6 +202,9 @@ server.stop: ## Stop the local webserver
 es.reindex: ## Reindex elasticsearch
 	${CONSOLE} monsieurbiz:search:populate
 
+consume.reindex: ## Consume reindex messages during 10min
+	${CONSOLE} messenger:consume async_search --time-limit=600 -vv
+
 doctrine.diff: ## Doctrine diff
 	${CONSOLE} doctrine:migration:diff
 

dist/config/packages/monsieurbiz_sylius_search_plugin.yaml

@@ -1,2 +1,7 @@
 imports:
   - { resource: "@MonsieurBizSyliusSearchPlugin/Resources/config/config.yaml" }
+
+monsieurbiz_sylius_search:
+  documents:
+    monsieurbiz_product:
+      prefix: 'myprefix' # define a custom index prefix

doc/Tips.md

@@ -0,0 +1,17 @@
+# Tips
+
+## Add prefix for index names and aliases
+
+In the `config/packages/monsieurbiz_sylius_search_plugin.yaml` file, add the `prefix` node for documents that need a prefix in the names of indexes and aliases.
+
+Example, for the products index:
+
+```diff
+imports:
+  - { resource: "@MonsieurBizSyliusSearchPlugin/Resources/config/config.yaml" }
+
++monsieurbiz_sylius_search:
++  documents:
++    monsieurbiz_product:
++     prefix: 'myproject' # define a custom index prefix
+```

src/DependencyInjection/Configuration.php

@@ -35,6 +35,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->defaultValue([])
                     ->arrayPrototype()
                         ->children()
+                            ->scalarNode('prefix')->defaultValue(null)->end()
                             ->scalarNode('document_class')->defaultValue(Documentable::class)->end()
                             ->scalarNode('instant_search_enabled')->defaultValue(false)->end()
                             ->scalarNode('source')->isRequired()->cannotBeEmpty()->end()

src/DependencyInjection/DocumentableRegistryPass.php

@@ -15,6 +15,7 @@
 
 use InvalidArgumentException;
 use MonsieurBiz\SyliusSearchPlugin\Model\Documentable\DocumentableInterface;
+use MonsieurBiz\SyliusSearchPlugin\Model\Documentable\PrefixedDocumentableInterface;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -56,6 +57,9 @@ public function process(ContainerBuilder $container): void
             $documentableDefinition->addTag('monsieurbiz.search.documentable');
             $documentableDefinition->addMethodCall('setMappingProvider', [new Reference($documentableConfiguration['mapping_provider'])]);
             $documentableDefinition->addMethodCall('setDatasource', [new Reference($documentableConfiguration['datasource'])]);
+            if ($this->isPrefixedDocumentableClass($documentableClass) && isset($documentableConfiguration['prefix'])) {
+                $documentableDefinition->addMethodCall('setPrefix', [$documentableConfiguration['prefix']]);
+            }
 
             // Add documentable into registry
             $registry->addMethodCall('register', [$documentableServiceId, new Reference($documentableServiceId)]);
@@ -81,4 +85,11 @@ private function validateDocumentableResource(string $class): void
             throw new InvalidArgumentException(sprintf('Class "%s" must implement "%s" to be registered as a Documentable.', $class, DocumentableInterface::class));
         }
     }
+
+    private function isPrefixedDocumentableClass(string $class): bool
+    {
+        $interfaces = (array) (class_implements($class) ?? []);
+
+        return \in_array(PrefixedDocumentableInterface::class, $interfaces, true);
+    }
 }

src/Index/Indexer.php

@@ -80,14 +80,14 @@ public function indexByDocuments(DocumentableInterface $documentable, array $doc
 
             return;
         }
-        $indexName = $this->getIndexName($documentable, $locale);
+        $index = $this->clientFactory->getIndex($documentable, $locale);
         foreach ($documents as $document) {
             if (null !== $locale && $document instanceof TranslatableInterface) {
                 $document->setCurrentLocale($locale);
             }
             $dto = $this->autoMapper->map($document, $documentable->getTargetClass());
             // @phpstan-ignore-next-line
-            $indexer->scheduleIndex($indexName, new Document((string) $document->getId(), $dto));
+            $indexer->scheduleIndex($index, new Document((string) $document->getId(), $dto));
         }
     }
 
@@ -107,12 +107,12 @@ public function deleteByDocuments(DocumentableInterface $documentable, array $do
             return;
         }
 
-        $indexName = $this->getIndexName($documentable, $locale);
+        $index = $this->clientFactory->getIndex($documentable, $locale);
         foreach ($documents as $document) {
             if (null !== $locale && $document instanceof TranslatableInterface) {
                 $document->setCurrentLocale($locale);
             }
-            $indexer->scheduleDelete($indexName, (string) $document->getId());
+            $indexer->scheduleDelete($index, (string) $document->getId());
         }
     }
 
@@ -169,11 +169,6 @@ private function indexDocumentable(DocumentableInterface $documentable, ?string
         $indexBuilder->purgeOldIndices($indexName);
     }
 
-    private function getIndexName(DocumentableInterface $documentable, ?string $locale = null): string
-    {
-        return $documentable->getIndexCode() . strtolower(null !== $locale ? '_' . $locale : '');
-    }
-
     /**
      * Convert proxies classes to the entity one.
      *

src/Model/Documentable/Documentable.php

@@ -15,7 +15,7 @@
 
 use Sylius\Component\Resource\Model\TranslatableInterface;
 
-class Documentable implements DocumentableInterface
+class Documentable implements PrefixedDocumentableInterface
 {
     use DocumentableDatasourceTrait;
 
@@ -34,6 +34,8 @@ class Documentable implements DocumentableInterface
 
     private array $limits;
 
+    private ?string $prefix = null;
+
     public function __construct(
         string $indexCode,
         string $sourceClass,
@@ -83,4 +85,14 @@ public function getLimits(?string $queryType = null): array
 
         return $this->limits[$queryType] ?? [];
     }
+
+    public function getPrefix(): string
+    {
+        return $this->prefix ?? '';
+    }
+
+    public function setPrefix(string $prefix): void
+    {
+        $this->prefix = $prefix;
+    }
 }

src/Model/Documentable/PrefixedDocumentableInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Search plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusSearchPlugin\Model\Documentable;
+
+interface PrefixedDocumentableInterface extends DocumentableInterface
+{
+    public function getPrefix(): string;
+
+    public function setPrefix(string $prefix): void;
+}

src/Resources/config/monsieurbiz_search.yaml

@@ -1,6 +1,7 @@
 monsieurbiz_sylius_search:
   documents:
     monsieurbiz_product:
+      #prefix: '…' # define a custom index prefix on index names and aliases
       #document_class: '…' # by default MonsieurBiz\SyliusSearchPlugin\Model\Documentable\Documentable
       instant_search_enabled: true # by default false
       limits:

src/Search/ClientFactory.php

@@ -13,11 +13,13 @@
 
 namespace MonsieurBiz\SyliusSearchPlugin\Search;
 
+use Elastica\Index;
 use JoliCode\Elastically\Client;
 use JoliCode\Elastically\Factory;
 use JoliCode\Elastically\IndexBuilder;
 use JoliCode\Elastically\Indexer;
 use MonsieurBiz\SyliusSearchPlugin\Model\Documentable\DocumentableInterface;
+use MonsieurBiz\SyliusSearchPlugin\Model\Documentable\PrefixedDocumentableInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 
 class ClientFactory
@@ -58,16 +60,34 @@ public function getIndexName(DocumentableInterface $documentable, ?string $local
         return $documentable->getIndexCode() . strtolower(null !== $locale ? '_' . $locale : '');
     }
 
-    private function getConfig(DocumentableInterface $documentable, ?string $localeCode): array
+    /**
+     * This method allows to find the name of the index with the prefix,
+     * because the methods of the JoliCode\ElasticallyIndexer class do not add
+     * it automatically.
+     */
+    public function getIndex(DocumentableInterface $documentable, ?string $locale): Index
     {
-        $indexName = $this->getIndexName($documentable, $localeCode);
+        $indexName = $this->getIndexName($documentable, $locale);
+        $factory = new Factory($this->getConfig($documentable, $locale, $indexName));
+        $client = $factory->buildClient();
+
+        return $client->getIndex($indexName);
+    }
+
+    private function getConfig(DocumentableInterface $documentable, ?string $localeCode, ?string $indexName = null): array
+    {
+        $indexName = $indexName ?? $this->getIndexName($documentable, $localeCode);
         $additionalConfig = [
             Factory::CONFIG_INDEX_CLASS_MAPPING => [
                 $indexName => $documentable->getTargetClass(),
             ],
             Factory::CONFIG_MAPPINGS_PROVIDER => $documentable->getMappingProvider(),
             Factory::CONFIG_SERIALIZER => $this->serializer,
         ];
+        $prefix = $documentable instanceof PrefixedDocumentableInterface ? trim($documentable->getPrefix()) : '';
+        if ('' !== $prefix) {
+            $additionalConfig[Factory::CONFIG_INDEX_PREFIX] = $prefix;
+        }
 
         return array_merge($this->config, $additionalConfig);
     }