vendor/pimcore/portal-engine/src/EventSubscriber/BatchTaskSubscriber.php line 77

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under following license:
  7.  * - Pimcore Commercial License (PCL)
  8.  *
  9.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  10.  *  @license    http://www.pimcore.org/license     PCL
  11.  */
  13. namespace Pimcore\Bundle\PortalEngineBundle\EventSubscriber;
  15. use Pimcore\Bundle\PortalEngineBundle\Entity\BatchTask;
  16. use Pimcore\Bundle\PortalEngineBundle\Message\BatchTask\Interfaces\BatchTaskMessageInterface;
  17. use Pimcore\Bundle\PortalEngineBundle\Message\BatchTask\Interfaces\SequentialBatchTaskMessageInterface;
  18. use Pimcore\Bundle\PortalEngineBundle\Message\BatchTask\Interfaces\SplittedBatchTaskMessageInterface;
  19. use Pimcore\Bundle\PortalEngineBundle\Message\BatchTask\Interfaces\TriggerFinishedMessageBatchTaskMessageInterface;
  20. use Pimcore\Bundle\PortalEngineBundle\Service\BatchTask\BatchTaskService;
  21. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  22. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  23. use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
  24. use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
  25. use Symfony\Component\Messenger\MessageBusInterface;
  27. /**
  28.  * Class IndexUpdateListener
  29.  *
  30.  * @package Pimcore\Bundle\PortalEngineBundle\EventListener
  31.  */
  32. class BatchTaskSubscriber implements EventSubscriberInterface
  33. {
  34.     /**
  35.      * @var BatchTaskService
  36.      */
  37.     protected $batchTaskService;
  39.     /**
  40.      * @var MessageBusInterface
  41.      */
  42.     protected $messageBus;
  44.     /**
  45.      * @var BatchTask
  46.      */
  47.     protected $terminateBatchTask;
  49.     /**
  50.      * @param BatchTaskService $batchTaskService
  51.      * @param MessageBusInterface $messengerBusPortalEngine
  52.      */
  53.     public function __construct(BatchTaskService $batchTaskService, MessageBusInterface $messengerBusPortalEngine)
  54.     {
  55.         $this->batchTaskService = $batchTaskService;
  56.         $this->messageBus = $messengerBusPortalEngine;
  57.     }
  59.     /**
  60.      * @return array
  61.      */
  62.     public static function getSubscribedEvents()
  63.     {
  64.         return [
  65.             WorkerMessageFailedEvent::class => 'onBatchTaskMessageFailed',
  66.             WorkerMessageHandledEvent::class => 'onWorkerMessageHandled',
  67.             TerminateEvent::class => 'onTerminate',
  68.         ];
  69.     }
  71.     /**
  72.      * Mark batch tasks with failed items as finished as otherwise they will run forever.
  73.      *
  74.      * @param WorkerMessageFailedEvent $event
  75.      *
  76.      */
  77.     public function onBatchTaskMessageFailed(WorkerMessageFailedEvent $event)
  78.     {
  79.         $message = $event->getEnvelope()->getMessage();
  80.         if (!$message instanceof BatchTaskMessageInterface) {
  81.             return;
  82.         }
  84.         if ($event->willRetry()) {
  85.             return;
  86.         }
  88.         if (!$batchTask = $this->batchTaskService->getTaskById($message->getTaskId())) {
  89.             return;
  90.         }
  92.         foreach (array_keys($message->getItems()) as $itemIndex) {
  93.             if (!$this->batchTaskService->isItemIndexProcessed($batchTask, $itemIndex)) {
  94.                 $this->batchTaskService->markItemIndexAsProcessed($batchTask, $itemIndex);
  95.             }
  96.         }
  98.         $this->checkBatchTaskFinished($batchTask, $message);
  99.     }
  101.     public function onWorkerMessageHandled(WorkerMessageHandledEvent $event)
  102.     {
  103.         $message = $event->getEnvelope()->getMessage();
  104.         if (!$message instanceof BatchTaskMessageInterface) {
  105.             return;
  106.         }
  108.         if ($message instanceof SplittedBatchTaskMessageInterface) {
  109.             return;
  110.         }
  112.         if (!$batchTask = $this->batchTaskService->getTaskById($message->getTaskId())) {
  113.             return;
  114.         }
  116.         if ($message instanceof SequentialBatchTaskMessageInterface && $message->hasRemainingItems()) {
  117.             $remainingMessage = $message->createRemainingMessage($this->batchTaskService);
  118.             $this->messageBus->dispatch($remainingMessage);
  120.             return;
  121.         }
  123.         $this->checkBatchTaskFinished($batchTask, $message);
  124.     }
  126.     public function onTerminate(TerminateEvent $event)
  127.     {
  128.         $this->batchTaskService->terminateBatchTask();
  129.     }
  131.     public function setTerminateBatchTask(BatchTask $batchTask)
  132.     {
  133.         $this->terminateBatchTask = $batchTask;
  134.     }
  136.     protected function checkBatchTaskFinished(BatchTask $batchTask, BatchTaskMessageInterface $message)
  137.     {
  138.         $this->batchTaskService->checkBatchTaskFinished($batchTask);
  140.         if ($message instanceof TriggerFinishedMessageBatchTaskMessageInterface) {
  141.             $finishedMessage = $message->createFinishedMessage();
  142.             $this->messageBus->dispatch($finishedMessage);
  143.         }
  144.     }
  145. }