ActionScheduler
2 months ago
CliCommands
1 month ago
Triggers
2 months ago
Workers
3 days ago
CronHelper.php
2 months ago
CronTrigger.php
2 years ago
CronWorkerInterface.php
3 years ago
CronWorkerRunner.php
2 months ago
CronWorkerScheduler.php
10 months ago
Daemon.php
3 days ago
DaemonActionSchedulerRunner.php
6 months ago
DaemonHttpRunner.php
2 months ago
Supervisor.php
3 years ago
index.php
3 years ago
CronWorkerRunner.php
192 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Cron; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\ScheduledTaskEntity; |
| 9 | use MailPoet\Logging\LoggerFactory; |
| 10 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 11 | use MailPoetVendor\Carbon\Carbon; |
| 12 | |
| 13 | class CronWorkerRunner { |
| 14 | const TASK_BATCH_SIZE = 5; |
| 15 | const TASK_RUN_TIMEOUT = 120; |
| 16 | const TIMED_OUT_TASK_RESCHEDULE_TIMEOUT = 5; |
| 17 | |
| 18 | /** @var float */ |
| 19 | private $timer; |
| 20 | |
| 21 | /** @var CronHelper */ |
| 22 | private $cronHelper; |
| 23 | |
| 24 | /** @var CronWorkerScheduler */ |
| 25 | private $cronWorkerScheduler; |
| 26 | |
| 27 | /** @var ScheduledTasksRepository */ |
| 28 | private $scheduledTasksRepository; |
| 29 | |
| 30 | /** @var LoggerFactory */ |
| 31 | private $loggerFactory; |
| 32 | |
| 33 | public function __construct( |
| 34 | CronHelper $cronHelper, |
| 35 | CronWorkerScheduler $cronWorkerScheduler, |
| 36 | ScheduledTasksRepository $scheduledTasksRepository, |
| 37 | LoggerFactory $loggerFactory |
| 38 | ) { |
| 39 | $this->timer = microtime(true); |
| 40 | $this->cronHelper = $cronHelper; |
| 41 | $this->cronWorkerScheduler = $cronWorkerScheduler; |
| 42 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 43 | $this->loggerFactory = $loggerFactory; |
| 44 | } |
| 45 | |
| 46 | public function run(CronWorkerInterface $worker) { |
| 47 | // abort if execution limit is reached |
| 48 | $this->cronHelper->enforceExecutionLimit($this->timer); |
| 49 | $dueTasks = $this->getDueTasks($worker); |
| 50 | $runningTasks = $this->getRunningTasks($worker); |
| 51 | |
| 52 | if (!$worker->checkProcessingRequirements()) { |
| 53 | foreach (array_merge($dueTasks, $runningTasks) as $task) { |
| 54 | $this->scheduledTasksRepository->remove($task); |
| 55 | $this->scheduledTasksRepository->flush(); |
| 56 | } |
| 57 | return false; |
| 58 | } |
| 59 | |
| 60 | $worker->init(); |
| 61 | |
| 62 | if (!$dueTasks && !$runningTasks) { |
| 63 | if ($worker->scheduleAutomatically()) { |
| 64 | $this->cronWorkerScheduler->schedule($worker->getTaskType(), $worker->getNextRunDate()); |
| 65 | } |
| 66 | return false; |
| 67 | } |
| 68 | |
| 69 | try { |
| 70 | foreach ($dueTasks as $task) { |
| 71 | $this->prepareTask($worker, $task); |
| 72 | } |
| 73 | // Re-fetch running tasks so that we can process tasks that were just prepared |
| 74 | $runningTasks = $this->getRunningTasks($worker); |
| 75 | foreach ($runningTasks as $task) { |
| 76 | $this->processTask($worker, $task); |
| 77 | } |
| 78 | } catch (\Exception $e) { |
| 79 | if (isset($task) && $task && $e->getCode() !== CronHelper::DAEMON_EXECUTION_LIMIT_REACHED) { |
| 80 | /** |
| 81 | * ToDo: Use \LoggerFactory::TOPIC_CRON as logger topic, once it is available |
| 82 | */ |
| 83 | $this->loggerFactory->getLogger()->error($e->getMessage(), ['error' => $e]); |
| 84 | $this->cronWorkerScheduler->rescheduleProgressively($task); |
| 85 | } |
| 86 | throw $e; |
| 87 | } |
| 88 | |
| 89 | return true; |
| 90 | } |
| 91 | |
| 92 | private function getDueTasks(CronWorkerInterface $worker) { |
| 93 | return $this->scheduledTasksRepository->findDueByType($worker->getTaskType(), self::TASK_BATCH_SIZE); |
| 94 | } |
| 95 | |
| 96 | private function getRunningTasks(CronWorkerInterface $worker) { |
| 97 | return $this->scheduledTasksRepository->findRunningByType($worker->getTaskType(), self::TASK_BATCH_SIZE); |
| 98 | } |
| 99 | |
| 100 | private function prepareTask(CronWorkerInterface $worker, ScheduledTaskEntity $task) { |
| 101 | // abort if execution limit is reached |
| 102 | $this->cronHelper->enforceExecutionLimit($this->timer); |
| 103 | |
| 104 | $prepareCompleted = $worker->prepareTaskStrategy($task, $this->timer); |
| 105 | |
| 106 | if ($prepareCompleted) { |
| 107 | $task->setStatus(null); |
| 108 | $this->scheduledTasksRepository->persist($task); |
| 109 | $this->scheduledTasksRepository->flush(); |
| 110 | } |
| 111 | } |
| 112 | |
| 113 | private function processTask(CronWorkerInterface $worker, ScheduledTaskEntity $task) { |
| 114 | // abort if execution limit is reached |
| 115 | $this->cronHelper->enforceExecutionLimit($this->timer); |
| 116 | |
| 117 | if (!$worker->supportsMultipleInstances()) { |
| 118 | if ($this->rescheduleOutdated($task)) { |
| 119 | return false; |
| 120 | } |
| 121 | if ($this->isInProgress($task)) { |
| 122 | return false; |
| 123 | } |
| 124 | } |
| 125 | |
| 126 | $this->startProgress($task); |
| 127 | |
| 128 | try { |
| 129 | $completed = $worker->processTaskStrategy($task, $this->timer); |
| 130 | } catch (\Exception $e) { |
| 131 | $this->stopProgress($task); |
| 132 | throw $e; |
| 133 | } |
| 134 | |
| 135 | if ($completed) { |
| 136 | $this->complete($task); |
| 137 | } |
| 138 | |
| 139 | $this->stopProgress($task); |
| 140 | |
| 141 | return (bool)$completed; |
| 142 | } |
| 143 | |
| 144 | private function rescheduleOutdated(ScheduledTaskEntity $task) { |
| 145 | $currentTime = Carbon::now()->millisecond(0); |
| 146 | |
| 147 | if (empty($task->getUpdatedAt())) { |
| 148 | // missing updatedAt, consider this task outdated (set year to 2000) and reschedule |
| 149 | $updatedAt = Carbon::createFromDate(2000); |
| 150 | } else if (!$task->getUpdatedAt() instanceof Carbon) { |
| 151 | $updatedAt = new Carbon($task->getUpdatedAt()); |
| 152 | } else { |
| 153 | $updatedAt = $task->getUpdatedAt(); |
| 154 | } |
| 155 | |
| 156 | // If the task is running for too long consider it stuck and reschedule |
| 157 | if ($updatedAt->diffInMinutes($currentTime, false) > self::TASK_RUN_TIMEOUT) { |
| 158 | $this->stopProgress($task); |
| 159 | $this->cronWorkerScheduler->reschedule($task, self::TIMED_OUT_TASK_RESCHEDULE_TIMEOUT); |
| 160 | return true; |
| 161 | } |
| 162 | return false; |
| 163 | } |
| 164 | |
| 165 | private function isInProgress(ScheduledTaskEntity $task) { |
| 166 | if ($task->getInProgress()) { |
| 167 | // Do not run multiple instances of the task |
| 168 | return true; |
| 169 | } |
| 170 | return false; |
| 171 | } |
| 172 | |
| 173 | private function startProgress(ScheduledTaskEntity $task) { |
| 174 | $task->setInProgress(true); |
| 175 | $this->scheduledTasksRepository->persist($task); |
| 176 | $this->scheduledTasksRepository->flush(); |
| 177 | } |
| 178 | |
| 179 | private function stopProgress(ScheduledTaskEntity $task) { |
| 180 | $task->setInProgress(false); |
| 181 | $this->scheduledTasksRepository->persist($task); |
| 182 | $this->scheduledTasksRepository->flush(); |
| 183 | } |
| 184 | |
| 185 | private function complete(ScheduledTaskEntity $task) { |
| 186 | $task->setProcessedAt(Carbon::now()->millisecond(0)); |
| 187 | $task->setStatus(ScheduledTaskEntity::STATUS_COMPLETED); |
| 188 | $this->scheduledTasksRepository->persist($task); |
| 189 | $this->scheduledTasksRepository->flush(); |
| 190 | } |
| 191 | } |
| 192 |