src/Core/Content/Product/DataAbstractionLayer/StockUpdater.php line 61

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\DataAbstractionLayer;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Checkout\Cart\Event\CheckoutOrderPlacedEvent;
  7. use Shopware\Core\Checkout\Cart\LineItem\LineItem;
  8. use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemDefinition;
  9. use Shopware\Core\Checkout\Order\OrderEvents;
  10. use Shopware\Core\Checkout\Order\OrderStates;
  11. use Shopware\Core\Content\Product\DataAbstractionLayer\StockUpdate\StockUpdateFilterProvider;
  12. use Shopware\Core\Content\Product\Events\ProductNoLongerAvailableEvent;
  13. use Shopware\Core\Defaults;
  14. use Shopware\Core\Framework\Context;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\RetryableQuery;
  16. use Shopware\Core\Framework\DataAbstractionLayer\EntityWriteResult;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenEvent;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\ChangeSetAware;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\DeleteCommand;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  22. use Shopware\Core\Framework\Log\Package;
  23. use Shopware\Core\Framework\Uuid\Uuid;
  24. use Shopware\Core\Profiling\Profiler;
  25. use Shopware\Core\System\StateMachine\Event\StateMachineTransitionEvent;
  26. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  27. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  29. /**
  30.  * @internal
  31.  */
  32. #[Package('core')]
  33. class StockUpdater implements EventSubscriberInterface
  34. {
  35.     /**
  36.      * @internal
  37.      */
  38.     public function __construct(
  39.         private readonly Connection $connection,
  40.         private readonly EventDispatcherInterface $dispatcher,
  41.         private readonly StockUpdateFilterProvider $stockUpdateFilter
  42.     ) {
  43.     }
  45.     /**
  46.      * Returns a list of custom business events to listen where the product maybe changed
  47.      *
  48.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  49.      */
  50.     public static function getSubscribedEvents(): array
  51.     {
  52.         return [
  53.             CheckoutOrderPlacedEvent::class => 'orderPlaced',
  54.             StateMachineTransitionEvent::class => 'stateChanged',
  55.             PreWriteValidationEvent::class => 'triggerChangeSet',
  56.             OrderEvents::ORDER_LINE_ITEM_WRITTEN_EVENT => 'lineItemWritten',
  57.             OrderEvents::ORDER_LINE_ITEM_DELETED_EVENT => 'lineItemWritten',
  58.         ];
  59.     }
  61.     public function triggerChangeSet(PreWriteValidationEvent $event): void
  62.     {
  63.         if ($event->getContext()->getVersionId() !== Defaults::LIVE_VERSION) {
  64.             return;
  65.         }
  67.         foreach ($event->getCommands() as $command) {
  68.             if (!$command instanceof ChangeSetAware) {
  69.                 continue;
  70.             }
  71.             /** @var ChangeSetAware&WriteCommand $command */
  72.             if ($command->getDefinition()->getEntityName() !== OrderLineItemDefinition::ENTITY_NAME) {
  73.                 continue;
  74.             }
  75.             if ($command instanceof DeleteCommand) {
  76.                 $command->requestChangeSet();
  78.                 continue;
  79.             }
  80.             /** @var WriteCommand&ChangeSetAware $command */
  81.             if ($command->hasField('referenced_id') || $command->hasField('product_id') || $command->hasField('quantity')) {
  82.                 $command->requestChangeSet();
  83.             }
  84.         }
  85.     }
  87.     public function orderPlaced(CheckoutOrderPlacedEvent $event): void
  88.     {
  89.         $ids = [];
  90.         foreach ($event->getOrder()->getLineItems() ?? [] as $lineItem) {
  91.             if ($lineItem->getType() !== LineItem::PRODUCT_LINE_ITEM_TYPE) {
  92.                 continue;
  93.             }
  95.             $referencedId = $lineItem->getReferencedId();
  96.             if (!$referencedId) {
  97.                 continue;
  98.             }
  100.             if (!\array_key_exists($referencedId, $ids)) {
  101.                 $ids[$referencedId] = 0;
  102.             }
  104.             $ids[$referencedId] += $lineItem->getQuantity();
  105.         }
  107.         $filteredIds = $this->stockUpdateFilter->filterProductIdsForStockUpdates(\array_keys($ids), $event->getContext());
  109.         $ids = \array_filter($ids, static fn (string $id) => \in_array($id, $filteredIds, true), \ARRAY_FILTER_USE_KEY);
  111.         // order placed event is a high load event. Because of the high load, we simply reduce the quantity here instead of executing the high costs `update` function
  112.         $query = new RetryableQuery(
  113.             $this->connection,
  114.             $this->connection->prepare('UPDATE product SET available_stock = available_stock - :quantity WHERE id = :id')
  115.         );
  117.         Profiler::trace('order::update-stock', static function () use ($query, $ids): void {
  118.             foreach ($ids as $id => $quantity) {
  119.                 $query->execute(['id' => Uuid::fromHexToBytes((string) $id), 'quantity' => $quantity]);
  120.             }
  121.         });
  123.         Profiler::trace('order::update-flag', function () use ($ids, $event): void {
  124.             $this->updateAvailableFlag(\array_keys($ids), $event->getContext());
  125.         });
  126.     }
  128.     /**
  129.      * If the product of an order item changed, the stocks of the old product and the new product must be updated.
  130.      */
  131.     public function lineItemWritten(EntityWrittenEvent $event): void
  132.     {
  133.         $ids = [];
  135.         // we don't want to trigger to `update` method when we are inside the order process
  136.         if ($event->getContext()->hasState('checkout-order-route')) {
  137.             return;
  138.         }
  140.         foreach ($event->getWriteResults() as $result) {
  141.             if ($result->hasPayload('referencedId') && $result->getProperty('type') === LineItem::PRODUCT_LINE_ITEM_TYPE) {
  142.                 $ids[] = $result->getProperty('referencedId');
  143.             }
  145.             if ($result->getOperation() === EntityWriteResult::OPERATION_INSERT) {
  146.                 continue;
  147.             }
  149.             $changeSet = $result->getChangeSet();
  150.             if (!$changeSet) {
  151.                 continue;
  152.             }
  154.             $type = $changeSet->getBefore('type');
  156.             if ($type !== LineItem::PRODUCT_LINE_ITEM_TYPE) {
  157.                 continue;
  158.             }
  160.             if (!$changeSet->hasChanged('referenced_id') && !$changeSet->hasChanged('quantity')) {
  161.                 continue;
  162.             }
  164.             $ids[] = $changeSet->getBefore('referenced_id');
  165.             $ids[] = $changeSet->getAfter('referenced_id');
  166.         }
  168.         $ids = array_filter(array_unique($ids));
  170.         if (empty($ids)) {
  171.             return;
  172.         }
  174.         $this->update($ids, $event->getContext());
  175.     }
  177.     public function stateChanged(StateMachineTransitionEvent $event): void
  178.     {
  179.         if ($event->getContext()->getVersionId() !== Defaults::LIVE_VERSION) {
  180.             return;
  181.         }
  183.         if ($event->getEntityName() !== 'order') {
  184.             return;
  185.         }
  187.         if ($event->getToPlace()->getTechnicalName() === OrderStates::STATE_COMPLETED) {
  188.             $products = $this->getProductsOfOrder($event->getEntityId(), $event->getContext());
  190.             $this->updateStockAndSales($products, -1);
  192.             return;
  193.         }
  195.         if ($event->getFromPlace()->getTechnicalName() === OrderStates::STATE_COMPLETED) {
  196.             $products = $this->getProductsOfOrder($event->getEntityId(), $event->getContext());
  198.             $this->updateStockAndSales($products, +1);
  200.             return;
  201.         }
  203.         if ($event->getToPlace()->getTechnicalName() === OrderStates::STATE_CANCELLED || $event->getFromPlace()->getTechnicalName() === OrderStates::STATE_CANCELLED) {
  204.             $products = $this->getProductsOfOrder($event->getEntityId(), $event->getContext());
  206.             $ids = array_column($products, 'referenced_id');
  208.             $this->updateAvailableStockAndSales($ids, $event->getContext());
  210.             $this->updateAvailableFlag($ids, $event->getContext());
  211.         }
  212.     }
  214.     /**
  215.      * @param list<string> $ids
  216.      */
  217.     public function update(array $ids, Context $context): void
  218.     {
  219.         if ($context->getVersionId() !== Defaults::LIVE_VERSION) {
  220.             return;
  221.         }
  223.         $ids = $this->stockUpdateFilter->filterProductIdsForStockUpdates($ids, $context);
  225.         $this->updateAvailableStockAndSales($ids, $context);
  227.         $this->updateAvailableFlag($ids, $context);
  228.     }
  230.     /**
  231.      * @param list<string> $ids
  232.      */
  233.     private function updateAvailableStockAndSales(array $ids, Context $context): void
  234.     {
  235.         $ids = array_filter(array_keys(array_flip($ids)));
  237.         if (empty($ids)) {
  238.             return;
  239.         }
  241.         $sql = '
  242. SELECT LOWER(HEX(order_line_item.product_id)) as product_id,
  243.     IFNULL(
  244.         SUM(IF(state_machine_state.technical_name = :completed_state, 0, order_line_item.quantity)),
  245.         0
  246.     ) as open_quantity,
  248.     IFNULL(
  249.         SUM(IF(state_machine_state.technical_name = :completed_state, order_line_item.quantity, 0)),
  250.         0
  251.     ) as sales_quantity
  253. FROM order_line_item
  254.     INNER JOIN `order`
  255.         ON `order`.id = order_line_item.order_id
  256.         AND `order`.version_id = order_line_item.order_version_id
  257.     INNER JOIN state_machine_state
  258.         ON state_machine_state.id = `order`.state_id
  259.         AND state_machine_state.technical_name <> :cancelled_state
  261. WHERE order_line_item.product_id IN (:ids)
  262.     AND order_line_item.type = :type
  263.     AND order_line_item.version_id = :version
  264.     AND order_line_item.product_id IS NOT NULL
  265. GROUP BY product_id;
  266.         ';
  268.         $rows = $this->connection->fetchAllAssociative(
  269.             $sql,
  270.             [
  271.                 'type' => LineItem::PRODUCT_LINE_ITEM_TYPE,
  272.                 'version' => Uuid::fromHexToBytes($context->getVersionId()),
  273.                 'completed_state' => OrderStates::STATE_COMPLETED,
  274.                 'cancelled_state' => OrderStates::STATE_CANCELLED,
  275.                 'ids' => Uuid::fromHexToBytesList($ids),
  276.             ],
  277.             [
  278.                 'ids' => Connection::PARAM_STR_ARRAY,
  279.             ]
  280.         );
  282.         $fallback = array_column($rows, 'product_id');
  284.         $fallback = array_diff($ids, $fallback);
  286.         $update = new RetryableQuery(
  287.             $this->connection,
  288.             $this->connection->prepare('UPDATE product SET available_stock = stock - :open_quantity, sales = :sales_quantity, updated_at = :now WHERE id = :id')
  289.         );
  291.         foreach ($fallback as $id) {
  292.             $update->execute([
  293.                 'id' => Uuid::fromHexToBytes((string) $id),
  294.                 'open_quantity' => 0,
  295.                 'sales_quantity' => 0,
  296.                 'now' => (new \DateTime())->format(Defaults::STORAGE_DATE_TIME_FORMAT),
  297.             ]);
  298.         }
  300.         foreach ($rows as $row) {
  301.             $update->execute([
  302.                 'id' => Uuid::fromHexToBytes($row['product_id']),
  303.                 'open_quantity' => $row['open_quantity'],
  304.                 'sales_quantity' => $row['sales_quantity'],
  305.                 'now' => (new \DateTime())->format(Defaults::STORAGE_DATE_TIME_FORMAT),
  306.             ]);
  307.         }
  308.     }
  310.     /**
  311.      * @param list<string> $ids
  312.      */
  313.     private function updateAvailableFlag(array $ids, Context $context): void
  314.     {
  315.         $ids = array_filter(array_unique($ids));
  317.         if (empty($ids)) {
  318.             return;
  319.         }
  321.         $bytes = Uuid::fromHexToBytesList($ids);
  323.         $sql = '
  324.             UPDATE product
  325.             LEFT JOIN product parent
  326.                 ON parent.id = product.parent_id
  327.                 AND parent.version_id = product.version_id
  329.             SET product.available = IFNULL((
  330.                 IFNULL(product.is_closeout, parent.is_closeout) * product.available_stock
  331.                 >=
  332.                 IFNULL(product.is_closeout, parent.is_closeout) * IFNULL(product.min_purchase, parent.min_purchase)
  333.             ), 0)
  334.             WHERE product.id IN (:ids)
  335.             AND product.version_id = :version
  336.         ';
  338.         RetryableQuery::retryable($this->connection, function () use ($sql, $context, $bytes): void {
  339.             $this->connection->executeStatement(
  340.                 $sql,
  341.                 ['ids' => $bytes, 'version' => Uuid::fromHexToBytes($context->getVersionId())],
  342.                 ['ids' => Connection::PARAM_STR_ARRAY]
  343.             );
  344.         });
  346.         $updated = $this->connection->fetchFirstColumn(
  347.             'SELECT LOWER(HEX(id)) FROM product WHERE available = 0 AND id IN (:ids) AND product.version_id = :version',
  348.             ['ids' => $bytes, 'version' => Uuid::fromHexToBytes($context->getVersionId())],
  349.             ['ids' => Connection::PARAM_STR_ARRAY]
  350.         );
  352.         if (!empty($updated)) {
  353.             $this->dispatcher->dispatch(new ProductNoLongerAvailableEvent($updated, $context));
  354.         }
  355.     }
  357.     /**
  358.      * @param list<array{referenced_id: string, quantity: string}> $products
  359.      */
  360.     private function updateStockAndSales(array $products, int $stockMultiplier): void
  361.     {
  362.         $query = new RetryableQuery(
  363.             $this->connection,
  364.             $this->connection->prepare('UPDATE product SET stock = stock + :quantity, sales = sales - :quantity WHERE id = :id AND version_id = :version')
  365.         );
  367.         foreach ($products as $product) {
  368.             $query->execute([
  369.                 'quantity' => (int) $product['quantity'] * $stockMultiplier,
  370.                 'id' => Uuid::fromHexToBytes($product['referenced_id']),
  371.                 'version' => Uuid::fromHexToBytes(Defaults::LIVE_VERSION),
  372.             ]);
  373.         }
  374.     }
  376.     /**
  377.      * @return list<array{referenced_id: string, quantity: string}>
  378.      */
  379.     private function getProductsOfOrder(string $orderId, Context $context): array
  380.     {
  381.         $query = $this->connection->createQueryBuilder();
  382.         $query->select(['referenced_id', 'quantity']);
  383.         $query->from('order_line_item');
  384.         $query->andWhere('type = :type');
  385.         $query->andWhere('order_id = :id');
  386.         $query->andWhere('version_id = :version');
  387.         $query->setParameter('id', Uuid::fromHexToBytes($orderId));
  388.         $query->setParameter('version', Uuid::fromHexToBytes(Defaults::LIVE_VERSION));
  389.         $query->setParameter('type', LineItem::PRODUCT_LINE_ITEM_TYPE);
  391.         /** @var list<array{referenced_id: string, quantity: string}> $result */
  392.         $result = $query->executeQuery()->fetchAllAssociative();
  394.         $filteredIds = $this->stockUpdateFilter->filterProductIdsForStockUpdates(\array_column($result, 'referenced_id'), $context);
  396.         return \array_filter($result, static fn (array $item) => \in_array($item['referenced_id'], $filteredIds, true));
  397.     }
  398. }