vendor/3slab/vdm-library-bundle/EventSubscriber/StopWorker/StopWorkerOnEmptyMessageSubscriber.php line 109

Open in your IDE?
  1. <?php
  3. /**
  4.  * @package    3slab/VdmLibraryBundle
  5.  * @copyright  2020 Suez Smart Solutions 3S.lab
  6.  * @license    https://github.com/3slab/VdmLibraryBundle/blob/master/LICENSE
  7.  */
  9. namespace Vdm\Bundle\LibraryBundle\EventSubscriber\StopWorker;
  11. use Psr\Log\LoggerInterface;
  12. use Psr\Log\NullLogger;
  13. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. use Symfony\Component\Messenger\Event\AbstractWorkerMessageEvent;
  15. use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
  16. use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
  17. use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
  18. use Vdm\Bundle\LibraryBundle\Event\CollectWorkerMessageFailedEvent;
  19. use Vdm\Bundle\LibraryBundle\Event\CollectWorkerMessageHandledEvent;
  20. use Vdm\Bundle\LibraryBundle\Event\CollectWorkerMessageReceivedEvent;
  21. use Vdm\Bundle\LibraryBundle\Model\IsEmptyMessageInterface;
  22. use Vdm\Bundle\LibraryBundle\Model\Message;
  23. use Vdm\Bundle\LibraryBundle\Service\StopWorkerService;
  25. /**
  26.  * Class StopWorkerOnEmptyMessageSubscriber
  27.  *
  28.  * @package Vdm\Bundle\LibraryBundle\EventSubscriber\StopWorker
  29.  */
  30. class StopWorkerOnEmptyMessageSubscriber implements EventSubscriberInterface
  31. {
  32.     /**
  33.      * @var StopWorkerService $stopWorker
  34.      */
  35.     private $stopWorker;
  37.     /**
  38.      * @var LoggerInterface
  39.      */
  40.     private $logger;
  42.     /**
  43.      * StopWorkOnEmptyMessageSubscriber constructor.
  44.      *
  45.      * @param StopWorkerService $stopWorker
  46.      * @param LoggerInterface|null $vdmLogger
  47.      */
  48.     public function __construct(StopWorkerService $stopWorker, LoggerInterface $vdmLogger = null)
  49.     {
  50.         $this->stopWorker = $stopWorker;
  51.         $this->logger = $vdmLogger ?? new NullLogger();
  52.     }
  54.     /**
  55.      * Method executed on WorkerMessageFailedEvent event
  56.      *
  57.      * @param WorkerMessageFailedEvent $event
  58.      */
  59.     public function onWorkerMessageFailedEvent(WorkerMessageFailedEvent $event)
  60.     {
  61.         $this->isEmptyMessage($event, 'WorkerMessageFailedEvent');
  62.     }
  64.     /**
  65.      * Method executed on WorkerMessageHandledEvent event
  66.      *
  67.      * @param WorkerMessageHandledEvent $event
  68.      */
  69.     public function onWorkerMessageHandledEvent(WorkerMessageHandledEvent $event)
  70.     {
  71.         $this->isEmptyMessage($event, 'WorkerMessageReceivedEvent');
  72.     }
  74.     /**
  75.      * Method executed on WorkerMessageReceivedEvent event
  76.      *
  77.      * @param WorkerMessageReceivedEvent $event
  78.      */
  79.     public function onWorkerMessageReceivedEvent(WorkerMessageReceivedEvent $event)
  80.     {
  81.         $this->isEmptyMessage($event, 'WorkerMessageReceivedEvent');
  82.     }
  84.     /**
  85.      * Method executed on CollectWorkerMessageFailedEvent event
  86.      *
  87.      * @param CollectWorkerMessageFailedEvent $event
  88.      */
  89.     public function onCollectWorkerMessageFailedEvent(CollectWorkerMessageFailedEvent $event)
  90.     {
  91.         $this->isEmptyMessage($event, 'CollectWorkerMessageFailedEvent');
  92.     }
  94.     /**
  95.      * Method executed on CollectWorkerMessageHandledEvent event
  96.      *
  97.      * @param CollectWorkerMessageHandledEvent $event
  98.      */
  99.     public function onCollectWorkerMessageHandledEvent(CollectWorkerMessageHandledEvent $event)
  100.     {
  101.         $this->isEmptyMessage($event, 'CollectWorkerMessageReceivedEvent');
  102.     }
  104.     /**
  105.      * Method executed on CollectWorkerMessageReceivedEvent event
  106.      *
  107.      * @param CollectWorkerMessageReceivedEvent $event
  108.      */
  109.     public function onCollectWorkerMessageReceivedEvent(CollectWorkerMessageReceivedEvent $event)
  110.     {
  111.         $this->isEmptyMessage($event, 'CollectWorkerMessageReceivedEvent');
  112.     }
  114.     /**
  115.      * @param AbstractWorkerMessageEvent $event
  116.      * @param string $eventName
  117.      */
  118.     protected function isEmptyMessage(AbstractWorkerMessageEvent $event, string $eventName)
  119.     {
  120.         $message = $event->getEnvelope()->getMessage();
  121.         if (!$message instanceof IsEmptyMessageInterface) {
  122.             return;
  123.         }
  125.         if (!$message->isEmpty()) {
  126.             return;
  127.         }
  129.         $this->logger->debug(
  130.             'Empty message detected during event {eventName} so we schedule to stop the worker',
  131.             ['eventName' => $eventName]
  132.         );
  133.         $this->stopWorker->setFlag(true);
  135.         if ($event instanceof WorkerMessageReceivedEvent || $event instanceof CollectWorkerMessageReceivedEvent) {
  136.             $event->shouldHandle(false);
  137.             $this->logger->debug(
  138.                 'Set ShouldHandle flag on {eventName} event to false as the message is empty',
  139.                 ['eventName' => $eventName]
  140.             );
  141.         }
  142.     }
  144.     /**
  145.      * {@inheritDoc}
  146.      * @codeCoverageIgnore
  147.      */
  148.     public static function getSubscribedEvents(): array
  149.     {
  150.         return [
  151.             CollectWorkerMessageFailedEvent::class => 'onCollectWorkerMessageFailedEvent',
  152.             CollectWorkerMessageHandledEvent::class => 'onCollectWorkerMessageHandledEvent',
  153.             CollectWorkerMessageReceivedEvent::class => 'onCollectWorkerMessageReceivedEvent',
  154.             WorkerMessageFailedEvent::class => 'onWorkerMessageFailedEvent',
  155.             WorkerMessageHandledEvent::class => 'onWorkerMessageHandledEvent',
  156.             WorkerMessageReceivedEvent::class => 'onWorkerMessageReceivedEvent',
  157.         ];
  158.     }
  159. }