Add extension points for custom pricing/data and structure sync

Adds a ProductDocumentsIndexEvent (indexation) and a SearchRequestContextEvent
(search request, price_group_id) so a project can plug custom data/pricing
logic without decorating the plugin. Also lets several dataproviders
contribute to the same structure sync entity (catalog/sourceField/
sourceFieldOption), splitting the built-in attribute/option providers and
subscribers accordingly as a first real usage of that mechanism.

Refs #33, refs #1391443

Author: PierreGauthier

src/Command/StructureClean.php

@@ -47,7 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln("$message ...");
             // @phpstan-ignore method.dynamicName
             $this->synchonizer->{$method}(
-                $this->providers[$entity]->provide(),
+                $this->provideAll($entity),
                 true,
                 $isDryRun
             );

src/Command/StructureSync.php

@@ -27,8 +27,8 @@
 )]
 class StructureSync extends Command
 {
-    /** @var ProviderInterface[] */
-    protected array $providers;
+    /** @var array<string, ProviderInterface[]> */
+    protected array $providers = [];
 
     /** @var array<string, string> */
     protected array $syncMethod = [
@@ -45,7 +45,9 @@ public function __construct(
         iterable $providers,
     ) {
         parent::__construct();
-        $this->providers = iterator_to_array($providers);
+        foreach ($providers as $provider) {
+            $this->providers[$provider->getEntity()][] = $provider;
+        }
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -57,7 +59,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $time = microtime(true);
             $output->writeln("$message ...");
             // @phpstan-ignore method.dynamicName
-            $this->synchonizer->{$method}($this->providers[$entity]->provide());
+            $this->synchonizer->{$method}($this->provideAll($entity));
             $time = number_format(microtime(true) - $time, 2);
             $output->writeln("\033[1A$message <info>✔</info> ($time)s");
         }
@@ -66,4 +68,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         return 0;
     }
+
+    /**
+     * Merges the provide() results of every provider registered for the given entity,
+     * so several namespaces can contribute to it independently.
+     */
+    protected function provideAll(string $entity): iterable
+    {
+        foreach ($this->providers[$entity] ?? [] as $provider) {
+            yield from $provider->provide();
+        }
+    }
 }

src/Controller/Admin/GallyController.php

@@ -31,8 +31,8 @@
 
 final class GallyController extends AbstractController
 {
-    /** @var ProviderInterface[] */
-    protected array $providers;
+    /** @var array<string, ProviderInterface[]> */
+    protected array $providers = [];
 
     /** @var array<string, string> */
     protected array $syncMethod = [
@@ -49,9 +49,21 @@ public function __construct(
         private TranslatorInterface $translator,
         private CacheManager $cacheManager,
     ) {
-        /** @var ProviderInterface[] $providersArray */
-        $providersArray = iterator_to_array($providers);
-        $this->providers = $providersArray;
+        /** @var ProviderInterface $provider */
+        foreach ($providers as $provider) {
+            $this->providers[$provider->getEntity()][] = $provider;
+        }
+    }
+
+    /**
+     * Merges the provide() results of every provider registered for the given entity,
+     * so several namespaces can contribute to it independently.
+     */
+    private function provideAll(string $entity): iterable
+    {
+        foreach ($this->providers[$entity] ?? [] as $provider) {
+            yield from $provider->provide();
+        }
     }
 
     public function renderGallyConfigForm(Request $request): Response
@@ -122,7 +134,7 @@ public function renderSyncFieldsForm(Request $request): Response
             if ($validConnection) {
                 foreach ($this->syncMethod as $entity => $method) {
                     // @phpstan-ignore method.dynamicName
-                    $this->synchonizer->{$method}($this->providers[$entity]->provide());
+                    $this->synchonizer->{$method}($this->provideAll($entity));
                 }
                 $this->addFlash('success', $this->translator->trans('gally_sylius.ui.sync_success'));
             }

src/Event/ProductDocumentsIndexEvent.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gally\SyliusPlugin\Event;
+
+use Sylius\Component\Core\Model\ProductInterface;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Dispatched once per channel/locale batch during product indexation, so a project
+ * can add custom fields or override existing ones (e.g. price) in the documents
+ * about to be sent to Gally, using the already-loaded product collection.
+ */
+final class ProductDocumentsIndexEvent extends Event
+{
+    /** @var array<int|string, array> */
+    private array $documents;
+
+    /**
+     * @param iterable<ProductInterface> $products
+     * @param array<int|string, array> $documents keyed by product id, mutable in place
+     */
+    public function __construct(
+        private iterable $products,
+        array &$documents,
+    ) {
+        $this->documents = &$documents;
+    }
+
+    /**
+     * @return iterable<ProductInterface>
+     */
+    public function getProducts(): iterable
+    {
+        return $this->products;
+    }
+
+    /**
+     * @return array<int|string, array>
+     */
+    public function getDocuments(): array
+    {
+        return $this->documents;
+    }
+
+    public function setDocument(int|string $productId, array $document): void
+    {
+        $this->documents[$productId] = $document;
+    }
+}

src/Event/SearchRequestContextEvent.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gally\SyliusPlugin\Event;
+
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Dispatched right before building a Gally search Request, so a project can
+ * override contextual values (e.g. the price group id) that the connector
+ * has no reliable way to infer on its own.
+ */
+final class SearchRequestContextEvent extends Event
+{
+    private ?string $priceGroupId = null;
+
+    public function getPriceGroupId(): ?string
+    {
+        return $this->priceGroupId;
+    }
+
+    public function setPriceGroupId(?string $priceGroupId): void
+    {
+        $this->priceGroupId = $priceGroupId;
+    }
+}

src/Grid/Gally/PagerfantaGallyAdapter.php

@@ -20,6 +20,7 @@
 use Gally\Sdk\GraphQl\Request;
 use Gally\Sdk\Service\SearchManager;
 use Gally\SyliusPlugin\Event\GridFilterUpdateEvent;
+use Gally\SyliusPlugin\Event\SearchRequestContextEvent;
 use Gally\SyliusPlugin\Search\Aggregation\AggregationBuilder;
 use Gally\SyliusPlugin\Search\Result;
 use Pagerfanta\Adapter\AdapterInterface;
@@ -81,6 +82,9 @@ public function getSlice(int $offset, int $length): iterable
         /** @var int|string $page */
         $page = $this->parameters->get('page', 1);
 
+        $context = new SearchRequestContextEvent();
+        $this->eventDispatcher->dispatch($context, 'gally.search.build_request');
+
         $request = new Request(
             $this->currentLocalizedCatalog,
             new Metadata('product'),
@@ -92,7 +96,8 @@ public function getSlice(int $offset, int $length): iterable
             $search,
             $this->filters,
             (string) $sortField,
-            $sortDirection
+            $sortDirection,
+            $context->getPriceGroupId()
         );
         $response = $this->searchManager->search($request);
         $productNumbers = [];

src/Grid/Gally/Search/SearchAdapter.php

@@ -19,6 +19,7 @@
 use Gally\Sdk\GraphQl\Request;
 use Gally\Sdk\Service\SearchManager;
 use Gally\SyliusPlugin\Event\GridFilterUpdateEvent;
+use Gally\SyliusPlugin\Event\SearchRequestContextEvent;
 use Gally\SyliusPlugin\Grid\Gally\GallyAdapterInterface;
 use Gally\SyliusPlugin\Indexer\Provider\CatalogProvider;
 use Gally\SyliusPlugin\Search\Aggregation\AggregationBuilder;
@@ -73,6 +74,9 @@ public function getSlice(int $offset, int $length): iterable
         $sortDirection = $sorting[$sortField] ?? null;
         $page = (int) $page;
 
+        $context = new SearchRequestContextEvent();
+        $this->eventDispatcher->dispatch($context, 'gally.search.build_request');
+
         $request = new Request(
             $this->catalogProvider->getLocalizedCatalog(),
             new Metadata('product'),
@@ -84,7 +88,8 @@ public function getSlice(int $offset, int $length): iterable
             $search,
             $this->filters,
             (string) $sortField,
-            $sortDirection
+            $sortDirection,
+            $context->getPriceGroupId()
         );
         $response = $this->searchManager->search($request);
 

src/Indexer/ProductIndexer.php

@@ -15,6 +15,7 @@
 namespace Gally\SyliusPlugin\Indexer;
 
 use Gally\Sdk\Service\IndexOperation;
+use Gally\SyliusPlugin\Event\ProductDocumentsIndexEvent;
 use Gally\SyliusPlugin\Indexer\Provider\CatalogProvider;
 use Sylius\Component\Attribute\Model\AttributeValueInterface;
 use Sylius\Component\Core\Calculator\ProductVariantPricesCalculatorInterface;
@@ -26,6 +27,7 @@
 use Sylius\Component\Locale\Model\LocaleInterface;
 use Sylius\Component\Product\Model\ProductOptionValueInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * Class ProductIndexer.
@@ -45,6 +47,7 @@ public function __construct(
         IndexOperation $indexOperation,
         private ProductRepositoryInterface $productRepository,
         private ProductVariantPricesCalculatorInterface $productVariantPriceCalculator,
+        private EventDispatcherInterface $eventDispatcher,
     ) {
         parent::__construct($channelRepository, $catalogProvider, $indexOperation);
     }
@@ -76,15 +79,25 @@ public function getDocumentsToIndex(
             );
             $products = $queryBuilder->getQuery()->execute();
         }
-        /** @var iterable $products */
+        $documents = [];
+        /** @var iterable<ProductInterface> $products */
         foreach ($products as $product) {
             /** @var ProductInterface $product */
             if (!$product->isEnabled()) {
                 continue;
             }
 
-            yield $this->formatProduct($product, $channel, $locale);
+            /** @var int|string $productId */
+            $productId = $product->getId();
+            $documents[(string) $productId] = $this->formatProduct($product, $channel, $locale);
         }
+
+        $this->eventDispatcher->dispatch(
+            new ProductDocumentsIndexEvent($products, $documents),
+            'gally.indexer.product.documents'
+        );
+
+        yield from $documents;
     }
 
     private function formatProduct(ProductInterface $product, ChannelInterface $channel, LocaleInterface $locale): array

src/Indexer/Provider/AbstractSourceFieldOptionProvider.php

@@ -0,0 +1,95 @@
+<?php
+/**
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade Gally to newer versions in the future.
+ *
+ * @package   Gally
+ * @author    Stephan Hochdörfer <S.Hochdoerfer@bitexpert.de>, Gally Team <elasticsuite@smile.fr>
+ * @copyright 2022-present Smile
+ * @license   Open Software License v. 3.0 (OSL-3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Gally\SyliusPlugin\Indexer\Provider;
+
+use Doctrine\Common\Collections\Collection;
+use Gally\Sdk\Entity\Label;
+use Gally\Sdk\Entity\LocalizedCatalog;
+use Gally\Sdk\Entity\SourceField;
+use Gally\Sdk\Entity\SourceFieldOption;
+use Sylius\Component\Product\Model\ProductOptionValueTranslation;
+
+/**
+ * Shared source field option building logic for the product attribute and product option providers.
+ */
+abstract class AbstractSourceFieldOptionProvider implements ProviderInterface
+{
+    /** @var LocalizedCatalog[] */
+    private array $localizedCatalogs = [];
+
+    public function __construct(protected CatalogProvider $catalogProvider)
+    {
+        foreach ($this->catalogProvider->provide() as $localizedCatalog) {
+            $this->localizedCatalogs[] = $localizedCatalog;
+        }
+    }
+
+    public function getEntity(): string
+    {
+        return 'sourceFieldOption';
+    }
+
+    /**
+     * @param Collection<int, ProductOptionValueTranslation>|list<array<string, string>> $translations
+     */
+    public function buildSourceFieldOption(
+        SourceField $sourceField,
+        string $code,
+        string $defaultLabel,
+        Collection|array $translations,
+        int $position,
+    ): SourceFieldOption {
+        /** @var Label[] $labels */
+        $labels = $this->getLabels($translations, $defaultLabel);
+
+        return new SourceFieldOption(
+            $sourceField,
+            $code,
+            $position,
+            $defaultLabel,
+            $labels,
+        );
+    }
+
+    /**
+     * @param Collection<int, ProductOptionValueTranslation>|list<array<string, string>> $translations
+     */
+    protected function getLabels(Collection|array $translations, string $defaultLabel): array
+    {
+        $labelsByLocal = [];
+        foreach ($translations as $translation) {
+            $locale = str_replace(
+                '-',
+                '_',
+                $translation instanceof ProductOptionValueTranslation
+                    ? (string) $translation->getLocale()
+                    : $translation['locale']
+            );
+            $labelsByLocal[$locale] = $translation instanceof ProductOptionValueTranslation
+                ? $translation->getValue()
+                : $translation['translation'];
+        }
+
+        $labels = [];
+        foreach ($this->localizedCatalogs as $localizedCatalog) {
+            $label = $labelsByLocal[$localizedCatalog->getLocale()] ?? null;
+            if (null !== $label && '' !== $label && $label !== $defaultLabel) {
+                $labels[] = new Label($localizedCatalog, $label);
+            }
+        }
+
+        return $labels;
+    }
+}