src/Core/Content/Product/DataAbstractionLayer/ProductIndexer.php line 100

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\DataAbstractionLayer;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Product\Events\ProductIndexerEvent;
  7. use Shopware\Core\Content\Product\ProductDefinition;
  8. use Shopware\Core\Defaults;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\Common\IterableQuery;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\Common\IteratorFactory;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\RetryableQuery;
  12. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\ChildCountUpdater;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexer;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexerRegistry;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexingMessage;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\InheritanceUpdater;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\ManyToManyIdFieldUpdater;
  20. use Shopware\Core\Framework\Log\Package;
  21. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  22. use Shopware\Core\Framework\Uuid\Uuid;
  23. use Shopware\Core\Profiling\Profiler;
  24. use Symfony\Component\Messenger\MessageBusInterface;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  27. #[Package('core')]
  28. class ProductIndexer extends EntityIndexer
  29. {
  30.     final public const INHERITANCE_UPDATER = 'product.inheritance';
  31.     final public const STOCK_UPDATER = 'product.stock';
  32.     final public const VARIANT_LISTING_UPDATER = 'product.variant-listing';
  33.     final public const CHILD_COUNT_UPDATER = 'product.child-count';
  34.     final public const MANY_TO_MANY_ID_FIELD_UPDATER = 'product.many-to-many-id-field';
  35.     final public const CATEGORY_DENORMALIZER_UPDATER = 'product.category-denormalizer';
  36.     final public const CHEAPEST_PRICE_UPDATER = 'product.cheapest-price';
  37.     final public const RATING_AVERAGE_UPDATER = 'product.rating-average';
  38.     final public const STREAM_UPDATER = 'product.stream';
  39.     final public const SEARCH_KEYWORD_UPDATER = 'product.search-keyword';
  40.     final public const STATES_UPDATER = 'product.states';
  42.     /**
  43.      * @internal
  44.      */
  45.     public function __construct(private readonly IteratorFactory $iteratorFactory, private readonly EntityRepository $repository, private readonly Connection $connection, private readonly VariantListingUpdater $variantListingUpdater, private readonly ProductCategoryDenormalizer $categoryDenormalizer, private readonly InheritanceUpdater $inheritanceUpdater, private readonly RatingAverageUpdater $ratingAverageUpdater, private readonly SearchKeywordUpdater $searchKeywordUpdater, private readonly ChildCountUpdater $childCountUpdater, private readonly ManyToManyIdFieldUpdater $manyToManyIdFieldUpdater, private readonly StockUpdater $stockUpdater, private readonly EventDispatcherInterface $eventDispatcher, private readonly CheapestPriceUpdater $cheapestPriceUpdater, private readonly ProductStreamUpdater $streamUpdater, private readonly StatesUpdater $statesUpdater, private readonly MessageBusInterface $messageBus)
  46.     {
  47.     }
  49.     public function getName(): string
  50.     {
  51.         return 'product.indexer';
  52.     }
  54.     /**
  55.      * @param array{offset: int|null}|null $offset
  56.      */
  57.     public function iterate(?array $offset): ?EntityIndexingMessage
  58.     {
  59.         $iterator = $this->getIterator($offset);
  61.         $ids = $iterator->fetch();
  63.         if (empty($ids)) {
  64.             return null;
  65.         }
  67.         return new ProductIndexingMessage(array_values($ids), $iterator->getOffset());
  68.     }
  70.     public function update(EntityWrittenContainerEvent $event): ?EntityIndexingMessage
  71.     {
  72.         $updates = $event->getPrimaryKeys(ProductDefinition::ENTITY_NAME);
  74.         if (empty($updates)) {
  75.             return null;
  76.         }
  78.         Profiler::trace('product:indexer:inheritance', function () use ($updates, $event): void {
  79.             $this->inheritanceUpdater->update(ProductDefinition::ENTITY_NAME, $updates, $event->getContext());
  80.         });
  82.         $stocks = $event->getPrimaryKeysWithPropertyChange(ProductDefinition::ENTITY_NAME, ['stock', 'isCloseout', 'minPurchase']);
  83.         Profiler::trace('product:indexer:stock', function () use ($stocks, $event): void {
  84.             $this->stockUpdater->update(array_values($stocks), $event->getContext());
  85.         });
  87.         $message = new ProductIndexingMessage(array_values($updates), null, $event->getContext());
  88.         $message->addSkip(self::INHERITANCE_UPDATER, self::STOCK_UPDATER);
  90.         $delayed = \array_unique(\array_filter(\array_merge(
  91.             $this->getParentIds($updates),
  92.             $this->getChildrenIds($updates)
  93.         )));
  95.         foreach (\array_chunk($delayed, 50) as $chunk) {
  96.             $child = new ProductIndexingMessage($chunk, null, $event->getContext());
  97.             $child->setIndexer($this->getName());
  98.             EntityIndexerRegistry::addSkips($child, $event->getContext());
  100.             $this->messageBus->dispatch($child);
  101.         }
  103.         return $message;
  104.     }
  106.     public function getTotal(): int
  107.     {
  108.         return $this->getIterator(null)->fetchCount();
  109.     }
  111.     public function getDecorated(): EntityIndexer
  112.     {
  113.         throw new DecorationPatternException(self::class);
  114.     }
  116.     public function handle(EntityIndexingMessage $message): void
  117.     {
  118.         $ids = array_values(array_unique(array_filter($message->getData())));
  120.         if (empty($ids)) {
  121.             return;
  122.         }
  124.         $parentIds = $this->filterVariants($ids);
  126.         $context = $message->getContext();
  128.         if ($message->allow(self::INHERITANCE_UPDATER)) {
  129.             Profiler::trace('product:indexer:inheritance', function () use ($ids, $context): void {
  130.                 $this->inheritanceUpdater->update(ProductDefinition::ENTITY_NAME, $ids, $context);
  131.             });
  132.         }
  134.         if ($message->allow(self::STOCK_UPDATER)) {
  135.             Profiler::trace('product:indexer:stock', function () use ($ids, $context): void {
  136.                 $this->stockUpdater->update($ids, $context);
  137.             });
  138.         }
  140.         if ($message->allow(self::VARIANT_LISTING_UPDATER)) {
  141.             Profiler::trace('product:indexer:variant-listing', function () use ($parentIds, $context): void {
  142.                 $this->variantListingUpdater->update($parentIds, $context);
  143.             });
  144.         }
  146.         if ($message->allow(self::CHILD_COUNT_UPDATER)) {
  147.             Profiler::trace('product:indexer:child-count', function () use ($parentIds, $context): void {
  148.                 $this->childCountUpdater->update(ProductDefinition::ENTITY_NAME, $parentIds, $context);
  149.             });
  150.         }
  152.         if ($message->allow(self::STREAM_UPDATER)) {
  153.             Profiler::trace('product:indexer:streams', function () use ($ids, $context): void {
  154.                 $this->streamUpdater->updateProducts($ids, $context);
  155.             });
  156.         }
  158.         if ($message->allow(self::MANY_TO_MANY_ID_FIELD_UPDATER)) {
  159.             Profiler::trace('product:indexer:many-to-many', function () use ($ids, $context): void {
  160.                 $this->manyToManyIdFieldUpdater->update(ProductDefinition::ENTITY_NAME, $ids, $context);
  161.             });
  162.         }
  164.         if ($message->allow(self::CATEGORY_DENORMALIZER_UPDATER)) {
  165.             Profiler::trace('product:indexer:category', function () use ($ids, $context): void {
  166.                 $this->categoryDenormalizer->update($ids, $context);
  167.             });
  168.         }
  170.         if ($message->allow(self::CHEAPEST_PRICE_UPDATER)) {
  171.             Profiler::trace('product:indexer:cheapest-price', function () use ($parentIds, $context): void {
  172.                 $this->cheapestPriceUpdater->update($parentIds, $context);
  173.             });
  174.         }
  176.         if ($message->allow(self::RATING_AVERAGE_UPDATER)) {
  177.             Profiler::trace('product:indexer:rating', function () use ($parentIds, $context): void {
  178.                 $this->ratingAverageUpdater->update($parentIds, $context);
  179.             });
  180.         }
  182.         if ($message->allow(self::SEARCH_KEYWORD_UPDATER)) {
  183.             Profiler::trace('product:indexer:search-keywords', function () use ($ids, $context): void {
  184.                 $this->searchKeywordUpdater->update($ids, $context);
  185.             });
  186.         }
  188.         if ($message->allow(self::STATES_UPDATER)) {
  189.             Profiler::trace('product:indexer:states', function () use ($ids, $context): void {
  190.                 $this->statesUpdater->update($ids, $context);
  191.             });
  192.         }
  194.         RetryableQuery::retryable($this->connection, function () use ($ids): void {
  195.             $this->connection->executeStatement(
  196.                 'UPDATE product SET updated_at = :now WHERE id IN (:ids)',
  197.                 ['ids' => Uuid::fromHexToBytesList($ids), 'now' => (new \DateTime())->format(Defaults::STORAGE_DATE_TIME_FORMAT)],
  198.                 ['ids' => Connection::PARAM_STR_ARRAY]
  199.             );
  200.         });
  202.         Profiler::trace('product:indexer:event', function () use ($ids, $context, $message): void {
  203.             $this->eventDispatcher->dispatch(new ProductIndexerEvent($ids, $context, $message->getSkip()));
  204.         });
  205.     }
  207.     /**
  208.      * @return string[]
  209.      */
  210.     public function getOptions(): array
  211.     {
  212.         return [
  213.             self::INHERITANCE_UPDATER,
  214.             self::STOCK_UPDATER,
  215.             self::VARIANT_LISTING_UPDATER,
  216.             self::CHILD_COUNT_UPDATER,
  217.             self::MANY_TO_MANY_ID_FIELD_UPDATER,
  218.             self::CATEGORY_DENORMALIZER_UPDATER,
  219.             self::CHEAPEST_PRICE_UPDATER,
  220.             self::RATING_AVERAGE_UPDATER,
  221.             self::STREAM_UPDATER,
  222.             self::SEARCH_KEYWORD_UPDATER,
  223.         ];
  224.     }
  226.     /**
  227.      * @param array<string> $ids
  228.      *
  229.      * @return array<string>
  230.      */
  231.     private function getChildrenIds(array $ids): array
  232.     {
  233.         $childrenIds = $this->connection->fetchFirstColumn(
  234.             'SELECT DISTINCT LOWER(HEX(id)) as id FROM product WHERE parent_id IN (:ids)',
  235.             ['ids' => Uuid::fromHexToBytesList($ids)],
  236.             ['ids' => Connection::PARAM_STR_ARRAY]
  237.         );
  239.         return array_unique(array_filter($childrenIds));
  240.     }
  242.     /**
  243.      * @param array<string> $ids
  244.      *
  245.      * @return string[]
  246.      */
  247.     private function getParentIds(array $ids): array
  248.     {
  249.         $parentIds = $this->connection->fetchFirstColumn(
  250.             'SELECT DISTINCT LOWER(HEX(product.parent_id)) as id FROM product WHERE id IN (:ids)',
  251.             ['ids' => Uuid::fromHexToBytesList($ids)],
  252.             ['ids' => Connection::PARAM_STR_ARRAY]
  253.         );
  255.         return array_unique(array_filter($parentIds));
  256.     }
  258.     /**
  259.      * @param array<string> $ids
  260.      *
  261.      * @return array|mixed[]
  262.      */
  263.     private function filterVariants(array $ids): array
  264.     {
  265.         return $this->connection->fetchFirstColumn(
  266.             'SELECT DISTINCT LOWER(HEX(`id`))
  267.              FROM product
  268.              WHERE `id` IN (:ids)
  269.              AND `parent_id` IS NULL',
  270.             ['ids' => Uuid::fromHexToBytesList($ids)],
  271.             ['ids' => Connection::PARAM_STR_ARRAY]
  272.         );
  273.     }
  275.     /**
  276.      * @param array{offset: int|null}|null $offset
  277.      */
  278.     private function getIterator(?array $offset): IterableQuery
  279.     {
  280.         return $this->iteratorFactory->createIterator($this->repository->getDefinition(), $offset);
  281.     }
  282. }