Move the index scope to a new namespace

loevgaard · loevgaard · commit ec56b3575b60 · 2024-07-03T22:03:21.000+02:00
diff --git a/composer.json b/composer.json
@@ -17,6 +17,7 @@
         "doctrine/persistence": "^2.5 || ^3.0",
         "liip/imagine-bundle": "^2.10",
         "meilisearch/meilisearch-php": "^1.8",
+        "ocramius/doctrine-batch-utils": "^2.6",
         "psr/cache": "^1.0 || ^2.0 || ^3.0",
         "psr/event-dispatcher": "^1.0",
         "psr/log": "^1.1 || ^2.0 || ^3.0",
diff --git a/src/DataMapper/CompositeDataMapper.php b/src/DataMapper/CompositeDataMapper.php
@@ -6,8 +6,8 @@
 
 use Setono\CompositeCompilerPass\CompositeService;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 /**
  * @extends CompositeService<DataMapperInterface>
diff --git a/src/DataMapper/DataMapperInterface.php b/src/DataMapper/DataMapperInterface.php
@@ -5,8 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\DataMapper;
 
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 interface DataMapperInterface
 {
diff --git a/src/DataMapper/ImageUrlsDataMapper.php b/src/DataMapper/ImageUrlsDataMapper.php
@@ -7,8 +7,8 @@
 use Liip\ImagineBundle\Imagine\Cache\CacheManager;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
 use Setono\SyliusMeilisearchPlugin\Document\ImageUrlsAwareInterface;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Component\Core\Model\ImagesAwareInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Webmozart\Assert\Assert;
diff --git a/src/DataMapper/IndexableDataMapper.php b/src/DataMapper/IndexableDataMapper.php
@@ -5,8 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\DataMapper;
 
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 final class IndexableDataMapper implements DataMapperInterface
 {
diff --git a/src/DataMapper/Product/PriceDataMapper.php b/src/DataMapper/Product/PriceDataMapper.php
@@ -8,8 +8,8 @@
 use Setono\SyliusMeilisearchPlugin\Document\Document;
 use Setono\SyliusMeilisearchPlugin\Document\Product as ProductDocument;
 use function Setono\SyliusMeilisearchPlugin\formatAmount;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Component\Channel\Model\ChannelInterface as BaseChannelInterface;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
diff --git a/src/DataMapper/Product/ProductDataMapper.php b/src/DataMapper/Product/ProductDataMapper.php
@@ -7,8 +7,8 @@
 use Setono\SyliusMeilisearchPlugin\DataMapper\DataMapperInterface;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
 use Setono\SyliusMeilisearchPlugin\Document\Product;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Component\Core\Model\ProductInterface;
 use Webmozart\Assert\Assert;
 
diff --git a/src/DataMapper/Product/TaxonCodesDataMapper.php b/src/DataMapper/Product/TaxonCodesDataMapper.php
@@ -7,8 +7,8 @@
 use Setono\SyliusMeilisearchPlugin\DataMapper\DataMapperInterface;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
 use Setono\SyliusMeilisearchPlugin\Document\Product as ProductDocument;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Component\Core\Model\ProductInterface;
 use Sylius\Component\Taxonomy\Model\TaxonInterface;
 use Webmozart\Assert\Assert;
diff --git a/src/DataMapper/Taxon/TaxonDataMapper.php b/src/DataMapper/Taxon/TaxonDataMapper.php
@@ -7,8 +7,8 @@
 use Setono\SyliusMeilisearchPlugin\DataMapper\DataMapperInterface;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
 use Setono\SyliusMeilisearchPlugin\Document\Taxon;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Sylius\Component\Core\Model\TaxonInterface;
 use Webmozart\Assert\Assert;
 
diff --git a/src/DataMapper/UrlDataMapper.php b/src/DataMapper/UrlDataMapper.php
@@ -6,8 +6,8 @@
 
 use Setono\SyliusMeilisearchPlugin\Document\Document;
 use Setono\SyliusMeilisearchPlugin\Document\UrlAwareInterface;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\UrlGenerator\EntityUrlGeneratorInterface;
 use Webmozart\Assert\Assert;
 
diff --git a/src/Document/Document.php b/src/Document/Document.php
@@ -4,8 +4,8 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Document;
 
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Settings\IndexSettings;
 
 /**
diff --git a/src/Document/Product.php b/src/Document/Product.php
@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Document;
 
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Settings\IndexSettings;
 
 /**
diff --git a/src/Document/Taxon.php b/src/Document/Taxon.php
@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Document;
 
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Settings\IndexSettings;
 
 /**
diff --git a/src/Filter/Object/CompositeFilter.php b/src/Filter/Object/CompositeFilter.php
@@ -5,8 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\Filter\Object;
 
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 final class CompositeFilter implements FilterInterface
 {
diff --git a/src/Filter/Object/FilterInterface.php b/src/Filter/Object/FilterInterface.php
@@ -5,8 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\Filter\Object;
 
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 interface FilterInterface
 {
diff --git a/src/Filter/Object/FilterableFilter.php b/src/Filter/Object/FilterableFilter.php
@@ -5,9 +5,9 @@
 namespace Setono\SyliusMeilisearchPlugin\Filter\Object;
 
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\FilterableInterface;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 final class FilterableFilter implements FilterInterface
 {
diff --git a/src/IndexScope/IndexScope.php b/src/IndexScope/IndexScope.php
diff --git a/src/Indexer/DefaultIndexer.php b/src/Indexer/DefaultIndexer.php
@@ -5,6 +5,7 @@
 namespace Setono\SyliusMeilisearchPlugin\Indexer;
 
 use Doctrine\Persistence\ManagerRegistry;
+use DoctrineBatchUtils\BatchProcessing\SelectBatchIteratorAggregate;
 use Meilisearch\Client;
 use Setono\Doctrine\ORMTrait;
 use Setono\SyliusMeilisearchPlugin\Config\Index;
@@ -51,16 +52,18 @@ public function indexEntities(array $entities): void
         }
 
         foreach ($this->indexScopeProvider->getAll($this->index) as $indexScope) {
+            $documents = [];
+
             foreach ($entities as $entity) {
                 $document = new $this->index->document();
                 $this->dataMapper->map($entity, $document, $indexScope);
 
                 $this->objectFilter->filter($entity, $document, $indexScope);
 
-                $data = $this->normalize($document);
-
-                $this->client->index($this->indexNameResolver->resolveFromIndexScope($indexScope))->addDocuments([$data]);
+                $documents[] = $this->normalize($document);
             }
+
+            $this->client->index($this->indexNameResolver->resolveFromIndexScope($indexScope))->addDocuments($documents, 'id');
         }
     }
 
@@ -82,8 +85,20 @@ public function removeEntities(array $entities): void
      */
     protected function indexEntityClass(string $entity): void
     {
-        // todo use Ocramius' batch library
-        throw new \RuntimeException('Not implemented');
+        $q = $this
+            ->getManager($entity)
+            ->createQueryBuilder()
+            ->select('o')
+            ->from($entity, 'o')
+            ->getQuery()
+        ;
+
+        /** @var SelectBatchIteratorAggregate<array-key, IndexableInterface> $objects */
+        $objects = SelectBatchIteratorAggregate::fromQuery($q, 100);
+
+        foreach ($objects as $object) {
+            $this->indexEntity($object);
+        }
     }
 
     // todo move this to a service
diff --git a/src/Model/FilterableInterface.php b/src/Model/FilterableInterface.php
@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Model;
 
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 /**
  * Implement this interface on entities that you want to filter in a simple way
diff --git a/src/Provider/IndexScope/CompositeIndexScopeProvider.php b/src/Provider/IndexScope/CompositeIndexScopeProvider.php
@@ -5,7 +5,6 @@
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexScope;
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 
 final class CompositeIndexScopeProvider implements IndexScopeProviderInterface
 {
diff --git a/src/Provider/IndexScope/DefaultIndexScopeProvider.php b/src/Provider/IndexScope/DefaultIndexScopeProvider.php
@@ -5,7 +5,6 @@
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexScope;
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 
 final class DefaultIndexScopeProvider implements IndexScopeProviderInterface
 {
diff --git a/src/Provider/IndexScope/IndexScope.php b/src/Provider/IndexScope/IndexScope.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Provider\IndexScope;
+
+use Setono\SyliusMeilisearchPlugin\Config\Index;
+
+final class IndexScope
+{
+    public function __construct(
+        /**
+         * The index that this scope applies to
+         */
+        public readonly Index $index,
+        public readonly ?string $channelCode = null,
+        public readonly ?string $localeCode = null,
+        public readonly ?string $currencyCode = null,
+    ) {
+    }
+}
diff --git a/src/Provider/IndexScope/IndexScopeProviderInterface.php b/src/Provider/IndexScope/IndexScopeProviderInterface.php
@@ -5,7 +5,6 @@
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexScope;
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 
 /**
  * The responsibility of the index scope provider is to provide all the relevant index scopes for a given index
diff --git a/src/Provider/IndexScope/ProductIndexScopeProvider.php b/src/Provider/IndexScope/ProductIndexScopeProvider.php
@@ -5,7 +5,6 @@
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexScope;
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Sylius\Component\Channel\Context\ChannelContextInterface;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
diff --git a/src/Provider/IndexScope/TaxonIndexScopeProvider.php b/src/Provider/IndexScope/TaxonIndexScopeProvider.php
@@ -5,7 +5,6 @@
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexScope;
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Sylius\Component\Core\Model\TaxonInterface;
 use Sylius\Component\Locale\Context\LocaleContextInterface;
 use Sylius\Component\Locale\Model\LocaleInterface;
diff --git a/src/Provider/IndexSettings/IndexSettingsProvider.php b/src/Provider/IndexSettings/IndexSettingsProvider.php
@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexSettings;
 
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Settings\IndexSettings;
 
 final class IndexSettingsProvider implements IndexSettingsProviderInterface
diff --git a/src/Provider/IndexSettings/IndexSettingsProviderInterface.php b/src/Provider/IndexSettings/IndexSettingsProviderInterface.php
@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Provider\IndexSettings;
 
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Settings\IndexSettings;
 
 interface IndexSettingsProviderInterface
diff --git a/src/Resolver/IndexName/IndexNameResolver.php b/src/Resolver/IndexName/IndexNameResolver.php
@@ -6,7 +6,7 @@
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
 use Setono\SyliusMeilisearchPlugin\Config\IndexRegistryInterface;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScopeProviderInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 
diff --git a/src/Resolver/IndexName/IndexNameResolverInterface.php b/src/Resolver/IndexName/IndexNameResolverInterface.php
@@ -5,8 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\Resolver\IndexName;
 
 use Setono\SyliusMeilisearchPlugin\Config\Index;
-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;
 
 interface IndexNameResolverInterface
 {
diff --git a/tests/Application/.gitignore b/tests/Application/.gitignore
@@ -9,6 +9,11 @@
 
 /node_modules
 
+###> meilisearch ###
+/data.ms/
+/meilisearch
+###< meilisearch ###
+
 ###> symfony/framework-bundle ###
 /.env.*.local
 /.env.local
diff --git a/tests/Application/meilisearch.sh b/tests/Application/meilisearch.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+
+if [ ! -f meilisearch ]; then
+    curl -L https://install.meilisearch.com | sh
+fi
+
+./meilisearch --master-key="aSampleMasterKey"
diff --git a/tests/Application/public/media/image/.gitignore b/tests/Application/public/media/image/.gitignore
diff --git a/tests/Resolver/IndexName/IndexNameResolverTest.php b/tests/Resolver/IndexName/IndexNameResolverTest.php

Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@`
`5`	`5`	`namespace Setono\SyliusMeilisearchPlugin\DataMapper;`
`6`	`6`
`7`	`7`	`use Setono\SyliusMeilisearchPlugin\Document\Document;`
`8`		`-use Setono\SyliusMeilisearchPlugin\IndexScope\IndexScope;`
`9`	`8`	`use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;`
	`9`	`+use Setono\SyliusMeilisearchPlugin\Provider\IndexScope\IndexScope;`
`10`	`10`
`11`	`11`	`interface DataMapperInterface`
`12`	`12`	`{`