ClaimedTaskRunner.php
1 month ago
Cli.php
1 month ago
CronCommand.php
1 month ago
DaemonRunner.php
1 month ago
ExecutionLimitOverride.php
1 month ago
ScheduledTaskResolver.php
1 month ago
ScheduledTasksLister.php
1 month ago
TaskAdder.php
1 month ago
TaskCanceller.php
1 month ago
TaskRunner.php
1 month ago
TaskTrigger.php
1 month ago
WorkerTypesCatalog.php
1 month ago
index.php
1 month ago
TaskRunner.php
288 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Cron\CliCommands; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use InvalidArgumentException; |
| 9 | use MailPoet\Cron\CronHelper; |
| 10 | use MailPoet\Cron\CronWorkerInterface; |
| 11 | use MailPoet\Cron\Workers\SendingQueue\SendingQueue as SendingQueueWorker; |
| 12 | use MailPoet\Cron\Workers\StatsNotifications\Worker as StatsNotificationsWorker; |
| 13 | use MailPoet\Cron\Workers\WorkersFactory; |
| 14 | use MailPoet\Entities\ScheduledTaskEntity; |
| 15 | use MailPoet\InvalidStateException; |
| 16 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 17 | use RuntimeException; |
| 18 | use Throwable; |
| 19 | |
| 20 | /** |
| 21 | * Runs a MailPoet cron worker inside the current process. |
| 22 | * |
| 23 | * Bulk `run <type>` snapshots the type's currently-due tasks, then claims each as a CLI row (status |
| 24 | * 'cli', invisible to the site daemon) and runs it once through the shared ClaimedTaskRunner — the same |
| 25 | * claim model as `run --task-id`. This closes the concurrency hole (the daemon can never double-process |
| 26 | * a row the CLI owns) and stops self-rescheduling batched workers from running away: continuations they |
| 27 | * create mid-run are not in the snapshot, so each due task processes one batch and the continuation is |
| 28 | * left for the site cron. Mailing workers run via process(), and 'sending' runs the Scheduler then the |
| 29 | * SendingQueue. `run --task-id` claims one exact row through ClaimedTaskRunner. The 20-second execution |
| 30 | * limit is lifted by default (or capped via $timeout). |
| 31 | * |
| 32 | * See doc/wp-cli-cron-commands.md for command behaviour and the cli-claim rationale. |
| 33 | */ |
| 34 | class TaskRunner { |
| 35 | private WorkerTypesCatalog $workerTypesCatalog; |
| 36 | |
| 37 | private WorkersFactory $workersFactory; |
| 38 | |
| 39 | private ExecutionLimitOverride $executionLimitOverride; |
| 40 | |
| 41 | private ScheduledTasksRepository $scheduledTasksRepository; |
| 42 | |
| 43 | private ScheduledTaskResolver $taskResolver; |
| 44 | |
| 45 | private ClaimedTaskRunner $claimedTaskRunner; |
| 46 | |
| 47 | public function __construct( |
| 48 | WorkerTypesCatalog $workerTypesCatalog, |
| 49 | WorkersFactory $workersFactory, |
| 50 | ExecutionLimitOverride $executionLimitOverride, |
| 51 | ScheduledTasksRepository $scheduledTasksRepository, |
| 52 | ScheduledTaskResolver $taskResolver, |
| 53 | ClaimedTaskRunner $claimedTaskRunner |
| 54 | ) { |
| 55 | $this->workerTypesCatalog = $workerTypesCatalog; |
| 56 | $this->workersFactory = $workersFactory; |
| 57 | $this->executionLimitOverride = $executionLimitOverride; |
| 58 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 59 | $this->taskResolver = $taskResolver; |
| 60 | $this->claimedTaskRunner = $claimedTaskRunner; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * @return array{completed: int, message: string, limit_reached: bool, backlog_drained: bool} |
| 65 | */ |
| 66 | public function run(string $type, ?int $taskId = null, ?int $timeout = null): array { |
| 67 | $this->workerTypesCatalog->assertValidType($type); |
| 68 | |
| 69 | if ($taskId !== null) { |
| 70 | return $this->runClaimedTask($type, $taskId, $timeout); |
| 71 | } |
| 72 | |
| 73 | if ($type === SendingQueueWorker::TASK_TYPE || $type === StatsNotificationsWorker::TASK_TYPE) { |
| 74 | return $this->runMailing($type, $timeout); |
| 75 | } |
| 76 | |
| 77 | return $this->runDueTasks($type, $timeout); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * --task-id: resolve the exact row (scheduled/paused only, type must match), claim it as a CLI row |
| 82 | * preserving its meta, and run it through the shared ClaimedTaskRunner. The shared CronWorkerRunner |
| 83 | * cannot see a STATUS_CLI row, so claiming is the only way the exact row is processed in-CLI. |
| 84 | * |
| 85 | * @return array{completed: int, message: string, limit_reached: bool, backlog_drained: bool} |
| 86 | */ |
| 87 | private function runClaimedTask(string $type, int $taskId, ?int $timeout): array { |
| 88 | $worker = $this->workerTypesCatalog->getWorkerByType($type); |
| 89 | if ($worker === null) { |
| 90 | throw new InvalidArgumentException("Task type '{$type}' has no runnable worker, so --task-id cannot run it in-process. Use `wp mailpoet cron trigger` for mailing types."); |
| 91 | } |
| 92 | |
| 93 | $task = $this->taskResolver->resolveById($taskId, $type); |
| 94 | $status = $task->getStatus(); |
| 95 | if (!in_array($status, [ScheduledTaskEntity::STATUS_SCHEDULED, ScheduledTaskEntity::STATUS_PAUSED], true)) { |
| 96 | $current = $this->taskResolver->nameStatus($task); |
| 97 | throw new InvalidArgumentException("Task {$taskId} is '{$current}' and cannot be run. Only scheduled or paused tasks can be run by ID."); |
| 98 | } |
| 99 | |
| 100 | if (!$this->claimedTaskRunner->claimExisting($task)) { |
| 101 | throw new RuntimeException(sprintf('Task %d was claimed by another process; nothing ran.', $taskId)); |
| 102 | } |
| 103 | |
| 104 | // ClaimedTaskRunner installs the execution-limit override itself, so the timeout is passed through |
| 105 | // rather than wrapped here — wrapping would be defeated by its own (inner) override. |
| 106 | $runResult = $this->claimedTaskRunner->run($worker, $task, $timeout); |
| 107 | |
| 108 | return [ |
| 109 | 'completed' => $runResult['completed'] ? 1 : 0, |
| 110 | 'limit_reached' => $runResult['limit_reached'], |
| 111 | 'backlog_drained' => $runResult['completed'], |
| 112 | 'message' => $runResult['message'], |
| 113 | ]; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Bulk `run <type>` for standard workers: snapshot the currently-due tasks, then claim and run each one |
| 118 | * exactly once through the shared ClaimedTaskRunner. Tasks are claimed as 'cli' so the site daemon |
| 119 | * cannot double-process them, and continuations created during the run (e.g. self-rescheduling batched |
| 120 | * workers) are not in the snapshot, so they are left for the site cron instead of being chased. |
| 121 | * |
| 122 | * @return array{completed: int, message: string, limit_reached: bool, backlog_drained: bool} |
| 123 | */ |
| 124 | private function runDueTasks(string $type, ?int $timeout): array { |
| 125 | $worker = $this->resolveWorker($type); |
| 126 | if ($worker === null) { |
| 127 | // Should be unreachable: assertValidType allows only mailing + standard types, and mailing types |
| 128 | // are handled before this method is called. |
| 129 | throw new InvalidArgumentException("Task type '{$type}' has no runnable worker."); |
| 130 | } |
| 131 | |
| 132 | // Pre-check requirements once so we never claim a task only to remove it on the requirements path. |
| 133 | try { |
| 134 | $requirementsMet = $worker->checkProcessingRequirements(); |
| 135 | } catch (Throwable $e) { |
| 136 | throw new RuntimeException(sprintf("Requirements check for '%s' failed: %s. Nothing ran.", $type, $e->getMessage()), 0, $e); |
| 137 | } |
| 138 | if (!$requirementsMet) { |
| 139 | // Nothing ran and the due tasks are left scheduled, so the backlog is not drained: surface a |
| 140 | // warning rather than a green success. |
| 141 | return [ |
| 142 | 'completed' => 0, |
| 143 | 'limit_reached' => false, |
| 144 | 'backlog_drained' => false, |
| 145 | 'message' => sprintf("Ran '%s': requirements not met, nothing ran.", $type), |
| 146 | ]; |
| 147 | } |
| 148 | |
| 149 | $dueTasks = $this->scheduledTasksRepository->findDueByType($type); |
| 150 | |
| 151 | $completed = 0; |
| 152 | $handedBack = 0; |
| 153 | $limitReached = false; |
| 154 | $start = microtime(true); |
| 155 | |
| 156 | foreach ($dueTasks as $task) { |
| 157 | // With --timeout, each task gets the run's remaining budget (capping the worker's own execution |
| 158 | // limit too, not just the gap between tasks); once it is spent we stop starting new tasks. |
| 159 | $remaining = null; |
| 160 | if ($timeout !== null) { |
| 161 | $remaining = $timeout - (microtime(true) - $start); |
| 162 | if ($remaining <= 0) { |
| 163 | $limitReached = true; |
| 164 | break; |
| 165 | } |
| 166 | } |
| 167 | |
| 168 | // Atomic claim: another CLI run (or the daemon) may have taken this row since the snapshot, so a |
| 169 | // lost claim is skipped rather than double-processed. |
| 170 | if (!$this->claimedTaskRunner->claimExisting($task)) { |
| 171 | continue; |
| 172 | } |
| 173 | |
| 174 | // A worker failure aborts the bulk run: already-processed tasks stay done, the failing one is |
| 175 | // handed back by ClaimedTaskRunner, and the RuntimeException propagates to the caller. |
| 176 | $result = $this->claimedTaskRunner->run($worker, $task, $remaining === null ? null : (int)ceil($remaining)); |
| 177 | if ($result['limit_reached']) { |
| 178 | // The task hit the cap and was handed back; stop the run so it is not counted as completed. |
| 179 | $limitReached = true; |
| 180 | break; |
| 181 | } |
| 182 | $result['completed'] ? $completed++ : $handedBack++; |
| 183 | } |
| 184 | |
| 185 | // Handed-back tasks (partial work, not ready, or a failed worker) are not "drained" — the command |
| 186 | // surfaces this as a warning so it is visible to operators and scripts. |
| 187 | $backlogDrained = !$limitReached && $handedBack === 0; |
| 188 | |
| 189 | return [ |
| 190 | 'completed' => $completed, |
| 191 | 'limit_reached' => $limitReached, |
| 192 | 'backlog_drained' => $backlogDrained, |
| 193 | 'message' => $this->buildMessage($type, $completed, $handedBack, $limitReached, $timeout), |
| 194 | ]; |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * Mailing types ('sending', 'stats_notification') run their own mailer-driven flow instead of |
| 199 | * CronWorkerInterface, via their own process step under the execution-limit override, surfacing a hit |
| 200 | * limit as limit_reached. |
| 201 | * |
| 202 | * @return array{completed: int, message: string, limit_reached: bool, backlog_drained: bool} |
| 203 | */ |
| 204 | private function runMailing(string $type, ?int $timeout): array { |
| 205 | $limitReached = false; |
| 206 | |
| 207 | try { |
| 208 | $this->executionLimitOverride->overrideDuring($timeout, function () use ($type): void { |
| 209 | if ($type === SendingQueueWorker::TASK_TYPE) { |
| 210 | $this->runSending(); |
| 211 | return; |
| 212 | } |
| 213 | $this->workersFactory->createStatsNotificationsWorker()->process(); |
| 214 | }); |
| 215 | } catch (\Exception $e) { |
| 216 | if ($e->getCode() === CronHelper::DAEMON_EXECUTION_LIMIT_REACHED) { |
| 217 | $limitReached = true; |
| 218 | } else { |
| 219 | throw $e; |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | if ($limitReached) { |
| 224 | return [ |
| 225 | 'completed' => 0, |
| 226 | 'limit_reached' => true, |
| 227 | 'backlog_drained' => false, |
| 228 | 'message' => sprintf("Execution limit of %d seconds reached while running '%s'.", (int)$timeout, $type), |
| 229 | ]; |
| 230 | } |
| 231 | |
| 232 | return [ |
| 233 | 'completed' => 0, |
| 234 | 'limit_reached' => false, |
| 235 | 'backlog_drained' => true, |
| 236 | 'message' => sprintf("Ran '%s'.", $type), |
| 237 | ]; |
| 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Seam over the catalog lookup so tests can drive the run with a stub worker. |
| 242 | */ |
| 243 | protected function resolveWorker(string $type): ?CronWorkerInterface { |
| 244 | return $this->workerTypesCatalog->getWorkerByType($type); |
| 245 | } |
| 246 | |
| 247 | private function runSending(): void { |
| 248 | // Scheduling first, then sending: the Scheduler turns scheduled newsletters into running sending |
| 249 | // tasks the SendingQueue then picks up. Instantiated lazily because the queue worker resolves the |
| 250 | // mailer eagerly and throws on a site with no sender configured. |
| 251 | try { |
| 252 | $scheduler = $this->workersFactory->createScheduleWorker(); |
| 253 | $queue = $this->workersFactory->createQueueWorker(); |
| 254 | } catch (InvalidStateException $e) { |
| 255 | throw new RuntimeException('Sending is not configured on this site: ' . $e->getMessage()); |
| 256 | } |
| 257 | |
| 258 | $scheduler->process(); |
| 259 | $queue->process(); |
| 260 | } |
| 261 | |
| 262 | private function buildMessage(string $type, int $completed, int $handedBack, bool $limitReached, ?int $timeout): string { |
| 263 | if ($limitReached) { |
| 264 | return sprintf( |
| 265 | "Execution limit of %d seconds reached while running '%s'. %d task(s) completed; remaining due tasks will run on the next invocation.", |
| 266 | (int)$timeout, |
| 267 | $type, |
| 268 | $completed |
| 269 | ); |
| 270 | } |
| 271 | |
| 272 | if ($handedBack > 0) { |
| 273 | return sprintf( |
| 274 | "Ran '%s': %d task(s) completed; %d task(s) handed back to the site cron (not ready or failed).", |
| 275 | $type, |
| 276 | $completed, |
| 277 | $handedBack |
| 278 | ); |
| 279 | } |
| 280 | |
| 281 | if ($completed > 0) { |
| 282 | return sprintf("Ran '%s': %d task(s) completed.", $type, $completed); |
| 283 | } |
| 284 | |
| 285 | return sprintf("Ran '%s': no tasks completed (nothing was due).", $type); |
| 286 | } |
| 287 | } |
| 288 |