Improve synonym functionality

composer.json

@@ -12,6 +12,7 @@
     "require": {
         "php": ">=8.1",
         "ext-json": "*",
+        "doctrine/collections": "^1.8 || ^2.0",
         "doctrine/event-manager": "^1.2 || ^2.0",
         "doctrine/orm": "^2.14 || ^3.0",
         "doctrine/persistence": "^2.5 || ^3.0",

src/DependencyInjection/SetonoSyliusMeilisearchExtension.php

@@ -111,9 +111,12 @@ public function prepend(ContainerBuilder $container): void
                             'type' => 'string',
                             'label' => 'sylius.ui.locale',
                         ],
-                        'channel' => [
-                            'type' => 'string',
-                            'label' => 'sylius.ui.channel',
+                        'channels' => [
+                            'type' => 'twig',
+                            'label' => 'sylius.ui.channels',
+                            'options' => [
+                                'template' => '@SyliusAdmin/Grid/Field/_channels.html.twig',
+                            ],
                         ],
                     ],
                     'filters' => [

src/Factory/SynonymFactory.php

@@ -30,7 +30,10 @@ public function createInverseFromExisting(SynonymInterface $synonym): SynonymInt
         $obj->setTerm($synonym->getSynonym());
         $obj->setSynonym($synonym->getTerm());
         $obj->setLocale($synonym->getLocale());
-        $obj->setChannel($synonym->getChannel());
+
+        foreach ($synonym->getChannels() as $channel) {
+            $obj->addChannel($channel);
+        }
 
         return $obj;
     }

src/EventSubscriber/NewSynonymSubscriber.php → src/Form/EventSubscriber/NewSynonymSubscriber.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Setono\SyliusMeilisearchPlugin\EventSubscriber;
+namespace Setono\SyliusMeilisearchPlugin\Form\EventSubscriber;
 
 use Doctrine\Persistence\ManagerRegistry;
 use Setono\Doctrine\ORMTrait;

src/Form/Type/IndexChoiceType.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Form\Type;
+
+use Setono\SyliusMeilisearchPlugin\Config\IndexRegistryInterface;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class IndexChoiceType extends AbstractType
+{
+    public function __construct(private readonly IndexRegistryInterface $indexRegistry)
+    {
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $names = $this->indexRegistry->getNames();
+
+        $resolver->setDefaults([
+            'choices' => array_combine($names, $names),
+            'choice_label' => static fn (string $name): string => ucfirst($name),
+        ]);
+    }
+
+    public function getParent(): string
+    {
+        return ChoiceType::class;
+    }
+
+    public function getBlockPrefix(): string
+    {
+        return 'setono_sylius_meilisearch_index_choice';
+    }
+}

src/Form/Type/SynonymType.php

@@ -9,6 +9,7 @@
 use Sylius\Bundle\LocaleBundle\Form\Type\LocaleChoiceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -42,8 +43,20 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             ->add('locale', LocaleChoiceType::class, [
                 'label' => 'sylius.ui.locale',
             ])
-            ->add('channel', ChannelChoiceType::class, [
-                'label' => 'sylius.ui.channel',
+            ->add('channels', ChannelChoiceType::class, [
+                'multiple' => true,
+                'expanded' => true,
+                'label' => 'sylius.ui.channels',
+                'required' => false,
+            ])
+            ->add('indexes', IndexChoiceType::class, [
+                'multiple' => true,
+                'expanded' => true,
+                'label' => 'setono_sylius_meilisearch.form.synonym.indexes',
+                'required' => false,
+            ])
+            ->add('enabled', CheckboxType::class, [
+                'label' => 'sylius.ui.enabled',
                 'required' => false,
             ])
             ->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event): void {

src/Meilisearch/SynonymResolver.php

@@ -17,6 +17,7 @@ public function __construct(private readonly SynonymRepositoryInterface $synonym
     public function resolve(IndexScope $indexScope): array
     {
         // it doesn't make sense to resolve synonyms if the locale is not set
+        // todo I am not sure this is true. You could have a single index with no scope and you'd still want synonyms
         if (null === $indexScope->localeCode) {
             return [];
         }
@@ -25,7 +26,7 @@ public function resolve(IndexScope $indexScope): array
         $synonyms = array_map(static fn (SynonymInterface $synonym): array => [
             'term' => (string) $synonym->getTerm(),
             'synonym' => (string) $synonym->getSynonym(),
-        ], $this->synonymRepository->findByLocaleAndChannel($indexScope->localeCode, $indexScope->channelCode));
+        ], $this->synonymRepository->findEnabledByIndexScope($indexScope));
 
         $resolvedSynonyms = [];
         foreach ($synonyms as $synonym) {

src/Model/Synonym.php

@@ -4,12 +4,17 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Model;
 
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Sylius\Component\Channel\Model\ChannelInterface;
 use Sylius\Component\Locale\Model\LocaleInterface;
+use Sylius\Component\Resource\Model\ToggleableTrait;
 use function Symfony\Component\String\u;
 
 class Synonym implements SynonymInterface
 {
+    use ToggleableTrait;
+
     protected ?int $id = null;
 
     protected ?string $term = null;
@@ -18,7 +23,16 @@ class Synonym implements SynonymInterface
 
     protected ?LocaleInterface $locale = null;
 
-    protected ?ChannelInterface $channel = null;
+    /** @var Collection<array-key, ChannelInterface> */
+    protected Collection $channels;
+
+    /** @var list<string>|null */
+    protected ?array $indexes = null;
+
+    public function __construct()
+    {
+        $this->channels = new ArrayCollection();
+    }
 
     public function getId(): ?int
     {
@@ -55,13 +69,53 @@ public function setLocale(?LocaleInterface $locale): void
         $this->locale = $locale;
     }
 
-    public function getChannel(): ?ChannelInterface
+    public function getChannels(): Collection
+    {
+        return $this->channels;
+    }
+
+    public function addChannel(ChannelInterface $channel): void
+    {
+        if (!$this->hasChannel($channel)) {
+            $this->channels->add($channel);
+        }
+    }
+
+    public function removeChannel(ChannelInterface $channel): void
+    {
+        if ($this->hasChannel($channel)) {
+            $this->channels->removeElement($channel);
+        }
+    }
+
+    public function hasChannel(ChannelInterface $channel): bool
+    {
+        return $this->channels->contains($channel);
+    }
+
+    public function getIndexes(): array
+    {
+        return $this->indexes ?? [];
+    }
+
+    public function addIndex(string $index): void
+    {
+        $this->indexes[] = $index;
+    }
+
+    public function removeIndex(string $index): void
     {
-        return $this->channel;
+        $indexes = $this->getIndexes();
+        $key = array_search($index, $indexes, true);
+        if ($key !== false) {
+            unset($indexes[$key]);
+        }
+
+        $this->indexes = [] === $indexes ? null : array_values($indexes);
     }
 
-    public function setChannel(?ChannelInterface $channel): void
+    public function hasIndex(string $index): bool
     {
-        $this->channel = $channel;
+        return in_array($index, $this->getIndexes(), true);
     }
 }

src/Model/SynonymInterface.php

@@ -4,12 +4,12 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Model;
 
-use Sylius\Component\Channel\Model\ChannelAwareInterface;
-use Sylius\Component\Channel\Model\ChannelInterface;
+use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Locale\Model\LocaleInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
+use Sylius\Component\Resource\Model\ToggleableInterface;
 
-interface SynonymInterface extends ResourceInterface, ChannelAwareInterface
+interface SynonymInterface extends ResourceInterface, ChannelsAwareInterface, ToggleableInterface
 {
     public function getId(): ?int;
 
@@ -25,8 +25,14 @@ public function getLocale(): ?LocaleInterface;
 
     public function setLocale(?LocaleInterface $locale): void;
 
-    // todo can we think of a scenario where we _really_ need the channel?
-    public function getChannel(): ?ChannelInterface;
+    /**
+     * @return list<string>
+     */
+    public function getIndexes(): array;
 
-    public function setChannel(?ChannelInterface $channel): void;
+    public function addIndex(string $index): void;
+
+    public function removeIndex(string $index): void;
+
+    public function hasIndex(string $index): bool;
 }

src/Repository/SynonymRepository.php

@@ -5,22 +5,29 @@
 namespace Setono\SyliusMeilisearchPlugin\Repository;
 
 use Setono\SyliusMeilisearchPlugin\Model\SynonymInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
 use Webmozart\Assert\Assert;
 
 class SynonymRepository extends EntityRepository implements SynonymRepositoryInterface
 {
-    public function findByLocaleAndChannel(string $localeCode, string $channelCode = null): array
+    public function findEnabledByIndexScope(IndexScope $indexScope): array
     {
         $qb = $this->createQueryBuilder('o')
-            ->join('o.locale', 'locale', 'WITH', 'locale.code = :localeCode')
-            ->setParameter('localeCode', $localeCode)
+            ->andWhere('o.enabled = true')
+            ->andWhere('o.indexes LIKE :index')
+            ->setParameter('index', '%"' . $indexScope->index->name . '"%')
         ;
 
-        if (null !== $channelCode) {
-            $qb->leftJoin('o.channel', 'c')
-                ->andWhere('o.channel IS NULL OR c.code = :channelCode')
-                ->setParameter('channelCode', $channelCode)
+        if (null !== $indexScope->localeCode) {
+            $qb->join('o.locale', 'locale', 'WITH', 'locale.code = :localeCode')
+                ->setParameter('localeCode', $indexScope->localeCode)
+            ;
+        }
+
+        if (null !== $indexScope->channelCode) {
+            $qb->join('o.channels', 'c', 'WITH', 'c.code = :channelCode')
+                ->setParameter('channelCode', $indexScope->channelCode)
             ;
         }
 

src/Repository/SynonymRepositoryInterface.php

@@ -5,6 +5,7 @@
 namespace Setono\SyliusMeilisearchPlugin\Repository;
 
 use Setono\SyliusMeilisearchPlugin\Model\SynonymInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 
 /**
@@ -15,5 +16,5 @@ interface SynonymRepositoryInterface extends RepositoryInterface
     /**
      * @return array<array-key, SynonymInterface>
      */
-    public function findByLocaleAndChannel(string $localeCode, string $channelCode = null): array;
+    public function findEnabledByIndexScope(IndexScope $indexScope): array;
 }

src/Resources/config/doctrine/model/Synonym.orm.xml

@@ -13,13 +13,22 @@
 
         <field name="term" type="string"/>
         <field name="synonym" type="string"/>
-
-        <many-to-one field="channel" target-entity="Sylius\Component\Channel\Model\ChannelInterface">
-            <join-column name="channel_id" referenced-column-name="id" nullable="true"/>
-        </many-to-one>
+        <field name="enabled" type="boolean" />
+        <field name="indexes" type="json" nullable="true"/>
 
         <many-to-one field="locale" target-entity="Sylius\Component\Locale\Model\LocaleInterface">
             <join-column name="locale_id" referenced-column-name="id" nullable="false"/>
         </many-to-one>
+
+        <many-to-many field="channels" target-entity="Sylius\Component\Channel\Model\ChannelInterface">
+            <join-table name="setono_sylius_meilisearch__synonym_channels">
+                <join-columns>
+                    <join-column name="synonym_id" referenced-column-name="id" nullable="false" on-delete="CASCADE"/>
+                </join-columns>
+                <inverse-join-columns>
+                    <join-column name="channel_id" referenced-column-name="id" nullable="false" on-delete="CASCADE"/>
+                </inverse-join-columns>
+            </join-table>
+        </many-to-many>
     </mapped-superclass>
 </doctrine-mapping>

src/Resources/config/services/event_subscriber.xml

@@ -5,12 +5,5 @@
         <service id="Setono\SyliusMeilisearchPlugin\EventSubscriber\AddMenuSubscriber">
             <tag name="kernel.event_subscriber"/>
         </service>
-
-        <service id="Setono\SyliusMeilisearchPlugin\EventSubscriber\NewSynonymSubscriber">
-            <argument type="service" id="doctrine"/>
-            <argument type="service" id="setono_sylius_meilisearch.factory.synonym"/>
-
-            <tag name="kernel.event_subscriber"/>
-        </service>
     </services>
 </container>

src/Resources/config/services/form.xml

@@ -33,18 +33,32 @@
         </service>
 
         <!-- Types -->
+        <service id="Setono\SyliusMeilisearchPlugin\Form\Type\IndexChoiceType">
+            <argument type="service" id="setono_sylius_meilisearch.config.index_registry"/>
+
+            <tag name="form.type"/>
+        </service>
+
         <service id="Setono\SyliusMeilisearchPlugin\Form\Type\SearchWidgetType">
             <argument type="service" id="request_stack"/>
 
             <tag name="form.type"/>
         </service>
 
         <service id="Setono\SyliusMeilisearchPlugin\Form\Type\SynonymType">
-            <argument type="service" id="Setono\SyliusMeilisearchPlugin\EventSubscriber\NewSynonymSubscriber"/>
+            <argument type="service" id="Setono\SyliusMeilisearchPlugin\Form\EventSubscriber\NewSynonymSubscriber"/>
             <argument>%setono_sylius_meilisearch.model.synonym.class%</argument>
             <argument>%setono_sylius_meilisearch.form.type.synonym.validation_groups%</argument>
 
             <tag name="form.type"/>
         </service>
+
+        <!-- Event subscribers -->
+        <service id="Setono\SyliusMeilisearchPlugin\Form\EventSubscriber\NewSynonymSubscriber">
+            <argument type="service" id="doctrine"/>
+            <argument type="service" id="setono_sylius_meilisearch.factory.synonym"/>
+
+            <tag name="kernel.event_subscriber"/>
+        </service>
     </services>
 </container>

src/Resources/translations/messages.en.yaml

@@ -16,6 +16,7 @@ setono_sylius_meilisearch:
                 label: Direction
                 one_way: One way
                 two_way: Two way
+            indexes: Indexes
     menu:
         admin:
             main: