src/Core/Framework/MessageQueue/ScheduledTask/ScheduledTaskHandler.php line 56

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\MessageQueue\ScheduledTask;
  5. use Shopware\Core\Defaults;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Symfony\Component\Messenger\Attribute\AsMessageHandler;
  11. use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
  13. /**
  14.  * @deprecated tag:v6.6.0 - reason:class-hierarchy-change - Won't implement MessageSubscriberInterface anymore, tag all ScheduledTaskHandlers with #[AsMessageHandler] instead
  15.  */
  16. #[Package('core')]
  17. abstract class ScheduledTaskHandler implements MessageSubscriberInterface
  18. {
  19.     protected EntityRepository $scheduledTaskRepository;
  21.     public function __construct(EntityRepository $scheduledTaskRepository)
  22.     {
  23.         $this->scheduledTaskRepository = $scheduledTaskRepository;
  24.     }
  26.     public function __invoke(ScheduledTask $task): void
  27.     {
  28.         $taskId = $task->getTaskId();
  30.         if ($taskId === null) {
  31.             // run task independent of the schedule
  32.             $this->run();
  34.             return;
  35.         }
  37.         /** @var ScheduledTaskEntity|null $taskEntity */
  38.         $taskEntity = $this->scheduledTaskRepository
  39.             ->search(new Criteria([$taskId]), Context::createDefaultContext())
  40.             ->get($taskId);
  42.         if ($taskEntity === null || !$taskEntity->isExecutionAllowed()) {
  43.             return;
  44.         }
  46.         $this->markTaskRunning($task);
  48.         try {
  49.             $this->run();
  50.         } catch (\Throwable $e) {
  51.             $this->markTaskFailed($task);
  53.             throw $e;
  54.         }
  56.         $this->rescheduleTask($task, $taskEntity);
  57.     }
  59.     /**
  60.      * @deprecated tag:v6.6.0 - reason:class-hierarchy-change - method will be removed, tag all ScheduledTaskHandlers with #[AsMessageHandler] instead
  61.      *
  62.      * @return iterable<string>
  63.      */
  64.     public static function getHandledMessages(): iterable
  65.     {
  66.         $reflection = new \ReflectionClass(static::class);
  67.         $attributes = $reflection->getAttributes(AsMessageHandler::class);
  69.         $messageClasses = [];
  70.         foreach ($attributes as $attribute) {
  71.             /** @var AsMessageHandler $messageAttribute */
  72.             $messageAttribute = $attribute->newInstance();
  73.             $messageClasses[] = $messageAttribute->handles;
  74.         }
  76.         return array_filter($messageClasses);
  77.     }
  79.     abstract public function run(): void;
  81.     protected function markTaskRunning(ScheduledTask $task): void
  82.     {
  83.         $this->scheduledTaskRepository->update([
  84.             [
  85.                 'id' => $task->getTaskId(),
  86.                 'status' => ScheduledTaskDefinition::STATUS_RUNNING,
  87.             ],
  88.         ], Context::createDefaultContext());
  89.     }
  91.     protected function markTaskFailed(ScheduledTask $task): void
  92.     {
  93.         $this->scheduledTaskRepository->update([
  94.             [
  95.                 'id' => $task->getTaskId(),
  96.                 'status' => ScheduledTaskDefinition::STATUS_FAILED,
  97.             ],
  98.         ], Context::createDefaultContext());
  99.     }
  101.     protected function rescheduleTask(ScheduledTask $task, ScheduledTaskEntity $taskEntity): void
  102.     {
  103.         $now = new \DateTimeImmutable();
  105.         $nextExecutionTimeString = $taskEntity->getNextExecutionTime()->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  106.         $nextExecutionTime = new \DateTimeImmutable($nextExecutionTimeString);
  107.         $newNextExecutionTime = $nextExecutionTime->modify(sprintf('+%d seconds', $taskEntity->getRunInterval()));
  109.         if ($newNextExecutionTime < $now) {
  110.             $newNextExecutionTime = $now;
  111.         }
  113.         $this->scheduledTaskRepository->update([
  114.             [
  115.                 'id' => $task->getTaskId(),
  116.                 'status' => ScheduledTaskDefinition::STATUS_SCHEDULED,
  117.                 'lastExecutionTime' => $now,
  118.                 'nextExecutionTime' => $newNextExecutionTime,
  119.             ],
  120.         ], Context::createDefaultContext());
  121.     }
  122. }