Ability to customize which identifiers to enqueue

config/services.xml

@@ -123,13 +123,15 @@
             <argument type="service" id="sylius.repository.product_association"/>
             <argument type="service" id="sylius.repository.product_association_type"/>
             <argument type="service" id="sylius.factory.product_association"/>
+            <argument type="service" id="event_dispatcher" />
             <tag name="webgriffe_sylius_akeneo.importer" />
         </service>
 
         <!-- Attribute Options Importer -->
         <service id="webgriffe_sylius_akeneo.attribute_options.importer" class="Webgriffe\SyliusAkeneoPlugin\AttributeOptions\Importer">
             <argument type="service" id="webgriffe_sylius_akeneo.api_client"/>
             <argument type="service" id="sylius.repository.product_attribute"/>
+            <argument type="service" id="event_dispatcher" />
             <tag name="webgriffe_sylius_akeneo.importer" />
         </service>
 

docs/architecture_and_customization.md

@@ -178,3 +178,46 @@ Another provided importer is the **attribute options
 importer** (`\Webgriffe\SyliusAkeneoPlugin\AttributeOptions\Importer`). This importer imports the Akeneo simple select
 and multi select attributes options into Sylius select attributes. The select attributes must already exist on Sylius
 with the same code they have on Akeneo.
+
+## Customize which Akeneo products to import
+
+Each built-in importer described above implements a `getIdentiferModifiedSince()` method.
+This method is used to identify which Akeneo entity identifiers should be imported or reconciled when the corresponding CLI commands run.
+By default, those methods return all the Akeneo identifiers of entities modified since the given date.
+But maybe you want to only import a subset of those Akeneo entities.
+
+For example, you might want to only import Akeneo products that have a not-empty family and a completeness of 100% for the `ecommerce` Akeneo channel.
+To do so you can define an event listener or subscriber for the `Webgriffe\SyliusAkeneoPlugin\Event\IdentifiersModifiedSinceSearchBuilderBuiltEvent` event and add the corresponding filters to the `SearchBuilder` object:
+
+```php
+// src/EventSubscriber/IdentifiersModifiedSinceSearchBuilderBuiltEventSubscriber.php
+
+namespace App\EventSubscriber;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Webgriffe\SyliusAkeneoPlugin\Event\IdentifiersModifiedSinceSearchBuilderBuiltEvent;
+use Webgriffe\SyliusAkeneoPlugin\Product\Importer as ProductImporter;
+use Webgriffe\SyliusAkeneoPlugin\ProductAssociations\Importer as ProductAssociationsImporter;
+
+final class IdentifiersModifiedSinceSearchBuilderBuiltEventSubscriber implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            IdentifiersModifiedSinceSearchBuilderBuiltEvent::class => 'onIdentifiersModifiedSinceSearchBuilderBuilt',
+        ];    
+    }
+
+    public function onIdentifiersModifiedSinceSearchBuilderBuilt(IdentifiersModifiedSinceSearchBuilderBuiltEvent $event): void
+    {
+        if (!$event->getImporter() instanceof ProductImporter &&
+            !$event->getImporter() instanceof ProductAssociationsImporter) {
+            return;
+        }
+
+        $searchBuilder = $event->getSearchBuilder();
+        $searchBuilder->addFilter('family', 'NOT EMPTY');
+        $searchBuilder->addFilter('completeness', '=', 100, ['scope' => 'ecommerce']);
+    }
+}
+```

src/AttributeOptions/Importer.php

@@ -5,9 +5,12 @@
 namespace Webgriffe\SyliusAkeneoPlugin\AttributeOptions;
 
 use Akeneo\Pim\ApiClient\AkeneoPimClientInterface;
+use Akeneo\Pim\ApiClient\Search\SearchBuilder;
 use Sylius\Component\Attribute\AttributeType\SelectAttributeType;
 use Sylius\Component\Product\Model\ProductAttributeInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Webgriffe\SyliusAkeneoPlugin\Event\IdentifiersModifiedSinceSearchBuilderBuiltEvent;
 use Webgriffe\SyliusAkeneoPlugin\ImporterInterface;
 
 final class Importer implements ImporterInterface
@@ -22,6 +25,7 @@ final class Importer implements ImporterInterface
     public function __construct(
         private AkeneoPimClientInterface $apiClient,
         private RepositoryInterface $attributeRepository,
+        private EventDispatcherInterface $eventDispatcher,
     ) {
     }
 
@@ -59,13 +63,18 @@ public function import(string $identifier): void
     }
 
     /**
-     * It's not possible to fetch only attributes or attribute options modified since a given date with the Akeneo
-     * REST API. So, the $sinceDate argument it's not used.
+     * As stated at https://api.akeneo.com/documentation/filter.html#by-update-date-3:
+     * > For Simple select and Multiple select attribute, an option update isn't considered as an attribute update.
+     * So, the $sinceDate argument it's not used here.
      */
     public function getIdentifiersModifiedSince(\DateTime $sinceDate): array
     {
+        $searchBuilder = new SearchBuilder();
+        $this->eventDispatcher->dispatch(
+            new IdentifiersModifiedSinceSearchBuilderBuiltEvent($this, $searchBuilder, $sinceDate),
+        );
         /** @var array<array-key, array<string, mixed>> $akeneoAttributes */
-        $akeneoAttributes = $this->apiClient->getAttributeApi()->all();
+        $akeneoAttributes = $this->apiClient->getAttributeApi()->all(50, ['search' => $searchBuilder->getFilters()]);
         $syliusSelectAttributes = $this->attributeRepository->findBy(['type' => SelectAttributeType::TYPE]);
         $syliusSelectAttributes = array_filter(
             array_map(

src/Event/IdentifiersModifiedSinceSearchBuilderBuiltEvent.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\SyliusAkeneoPlugin\Event;
+
+use Akeneo\Pim\ApiClient\Search\SearchBuilder;
+use DateTimeInterface;
+use Webgriffe\SyliusAkeneoPlugin\ImporterInterface;
+
+/**
+ * @readonly
+ */
+final class IdentifiersModifiedSinceSearchBuilderBuiltEvent
+{
+    public function __construct(
+        private ImporterInterface $importer,
+        private SearchBuilder $searchBuilder,
+        private DateTimeInterface $sinceDate,
+    ) {
+    }
+
+    public function getImporter(): ImporterInterface
+    {
+        return $this->importer;
+    }
+
+    public function getSearchBuilder(): SearchBuilder
+    {
+        return $this->searchBuilder;
+    }
+
+    public function getSinceDate(): DateTimeInterface
+    {
+        return $this->sinceDate;
+    }
+}

src/Product/Importer.php

@@ -20,6 +20,7 @@
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Webgriffe\SyliusAkeneoPlugin\Event\IdentifiersModifiedSinceSearchBuilderBuiltEvent;
 use Webgriffe\SyliusAkeneoPlugin\ImporterInterface;
 use Webgriffe\SyliusAkeneoPlugin\ReconcilerInterface;
 use Webgriffe\SyliusAkeneoPlugin\ValueHandlersResolverInterface;
@@ -112,6 +113,9 @@ public function getIdentifiersModifiedSince(DateTime $sinceDate): array
     {
         $searchBuilder = new SearchBuilder();
         $searchBuilder->addFilter('updated', '>', $sinceDate->format('Y-m-d H:i:s'));
+        $this->eventDispatcher->dispatch(
+            new IdentifiersModifiedSinceSearchBuilderBuiltEvent($this, $searchBuilder, $sinceDate),
+        );
         $products = $this->apiClient->getProductApi()->all(50, ['search' => $searchBuilder->getFilters()]);
         $identifiers = [];
         foreach ($products as $product) {

src/ProductAssociations/Importer.php

@@ -18,6 +18,8 @@
 use Sylius\Component\Product\Repository\ProductAssociationTypeRepositoryInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Webgriffe\SyliusAkeneoPlugin\Event\IdentifiersModifiedSinceSearchBuilderBuiltEvent;
 use Webgriffe\SyliusAkeneoPlugin\ImporterInterface;
 use Webmozart\Assert\Assert;
 
@@ -35,6 +37,7 @@ public function __construct(
         private RepositoryInterface $productAssociationRepository,
         private ProductAssociationTypeRepositoryInterface $productAssociationTypeRepository,
         private FactoryInterface $productAssociationFactory,
+        private EventDispatcherInterface $eventDispatcher,
     ) {
     }
 
@@ -130,6 +133,9 @@ public function getIdentifiersModifiedSince(DateTime $sinceDate): array
     {
         $searchBuilder = new SearchBuilder();
         $searchBuilder->addFilter('updated', '>', $sinceDate->format('Y-m-d H:i:s'));
+        $this->eventDispatcher->dispatch(
+            new IdentifiersModifiedSinceSearchBuilderBuiltEvent($this, $searchBuilder, $sinceDate),
+        );
         $products = $this->apiClient->getProductApi()->all(50, ['search' => $searchBuilder->getFilters()]);
         $identifiers = [];
         foreach ($products as $product) {