ActionScheduler.php
3 weeks ago
AutomationController.php
2 years ago
FilterHandler.php
1 month ago
RootStep.php
2 years ago
StepHandler.php
2 months ago
StepRunController.php
1 year ago
StepRunControllerFactory.php
1 year ago
StepRunLogger.php
2 months ago
StepRunLoggerFactory.php
2 years ago
StepScheduler.php
1 year ago
SubjectLoader.php
3 years ago
SubjectTransformerHandler.php
1 year ago
TriggerHandler.php
2 years ago
index.php
3 years ago
StepHandler.php
228 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Automation\Engine\Control; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use Exception; |
| 9 | use MailPoet\Automation\Engine\Data\Automation; |
| 10 | use MailPoet\Automation\Engine\Data\AutomationRun; |
| 11 | use MailPoet\Automation\Engine\Data\AutomationRunLog; |
| 12 | use MailPoet\Automation\Engine\Data\StepRunArgs; |
| 13 | use MailPoet\Automation\Engine\Data\StepValidationArgs; |
| 14 | use MailPoet\Automation\Engine\Data\SubjectEntry; |
| 15 | use MailPoet\Automation\Engine\Exceptions; |
| 16 | use MailPoet\Automation\Engine\Exceptions\InvalidStateException; |
| 17 | use MailPoet\Automation\Engine\Hooks; |
| 18 | use MailPoet\Automation\Engine\Integration\Action; |
| 19 | use MailPoet\Automation\Engine\Integration\Payload; |
| 20 | use MailPoet\Automation\Engine\Integration\Subject; |
| 21 | use MailPoet\Automation\Engine\Registry; |
| 22 | use MailPoet\Automation\Engine\Storage\AutomationRunStorage; |
| 23 | use MailPoet\Automation\Engine\Storage\AutomationStorage; |
| 24 | use MailPoet\Automation\Engine\WordPress; |
| 25 | use Throwable; |
| 26 | |
| 27 | class StepHandler { |
| 28 | /** @var SubjectLoader */ |
| 29 | private $subjectLoader; |
| 30 | |
| 31 | /** @var WordPress */ |
| 32 | private $wordPress; |
| 33 | |
| 34 | /** @var AutomationRunStorage */ |
| 35 | private $automationRunStorage; |
| 36 | |
| 37 | /** @var AutomationStorage */ |
| 38 | private $automationStorage; |
| 39 | |
| 40 | /** @var Registry */ |
| 41 | private $registry; |
| 42 | |
| 43 | /** @var StepRunControllerFactory */ |
| 44 | private $stepRunControllerFactory; |
| 45 | |
| 46 | /** @var StepRunLoggerFactory */ |
| 47 | private $stepRunLoggerFactory; |
| 48 | |
| 49 | /** @var StepScheduler */ |
| 50 | private $stepScheduler; |
| 51 | |
| 52 | public function __construct( |
| 53 | SubjectLoader $subjectLoader, |
| 54 | WordPress $wordPress, |
| 55 | AutomationRunStorage $automationRunStorage, |
| 56 | AutomationStorage $automationStorage, |
| 57 | Registry $registry, |
| 58 | StepRunControllerFactory $stepRunControllerFactory, |
| 59 | StepRunLoggerFactory $stepRunLoggerFactory, |
| 60 | StepScheduler $stepScheduler |
| 61 | ) { |
| 62 | $this->subjectLoader = $subjectLoader; |
| 63 | $this->wordPress = $wordPress; |
| 64 | $this->automationRunStorage = $automationRunStorage; |
| 65 | $this->automationStorage = $automationStorage; |
| 66 | $this->registry = $registry; |
| 67 | $this->stepRunControllerFactory = $stepRunControllerFactory; |
| 68 | $this->stepRunLoggerFactory = $stepRunLoggerFactory; |
| 69 | $this->stepScheduler = $stepScheduler; |
| 70 | } |
| 71 | |
| 72 | public function initialize(): void { |
| 73 | $this->wordPress->addAction(Hooks::AUTOMATION_STEP, [$this, 'handle']); |
| 74 | } |
| 75 | |
| 76 | /** @param mixed $args */ |
| 77 | public function handle($args): void { |
| 78 | // TODO: better args validation |
| 79 | if ( |
| 80 | !is_array($args) |
| 81 | || !isset($args['automation_run_id']) |
| 82 | || !is_numeric($args['automation_run_id']) |
| 83 | || !array_key_exists('step_id', $args) |
| 84 | || !is_scalar($args['step_id']) |
| 85 | ) { |
| 86 | throw new InvalidStateException(); |
| 87 | } |
| 88 | |
| 89 | $runId = (int)$args['automation_run_id']; |
| 90 | $stepId = (string)$args['step_id']; |
| 91 | $runNumber = is_numeric($args['run_number'] ?? null) ? (int)$args['run_number'] : 1; |
| 92 | |
| 93 | // BC — complete automation run if "step_id" is empty (was nullable in the past) |
| 94 | if (!$stepId) { |
| 95 | $this->automationRunStorage->updateStatus($runId, AutomationRun::STATUS_COMPLETE); |
| 96 | return; |
| 97 | } |
| 98 | |
| 99 | $logger = $this->stepRunLoggerFactory->createLogger($runId, $stepId, AutomationRunLog::TYPE_ACTION, $runNumber); |
| 100 | $logger->logStart(); |
| 101 | try { |
| 102 | $this->handleStep($runId, $stepId, $runNumber, $logger); |
| 103 | } catch (Throwable $e) { |
| 104 | $status = $e instanceof InvalidStateException && $e->getErrorCode() === 'mailpoet_automation_not_active' |
| 105 | ? AutomationRun::STATUS_CANCELLED |
| 106 | : AutomationRun::STATUS_FAILED; |
| 107 | $this->automationRunStorage->updateStatus($runId, $status); |
| 108 | $logger->logFailure($e); |
| 109 | |
| 110 | // Action Scheduler catches only Exception instances, not other errors. |
| 111 | // We need to convert them to exceptions to be processed and logged. |
| 112 | if (!$e instanceof Exception) { |
| 113 | throw new Exception($e->getMessage(), intval($e->getCode()), $e); |
| 114 | } |
| 115 | throw $e; |
| 116 | } finally { |
| 117 | $this->postProcessAutomationRun($runId); |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | private function handleStep(int $runId, string $stepId, int $runNumber, StepRunLogger $logger): void { |
| 122 | $automationRun = $this->automationRunStorage->getAutomationRun($runId); |
| 123 | if (!$automationRun) { |
| 124 | throw Exceptions::automationRunNotFound($runId); |
| 125 | } |
| 126 | |
| 127 | if ($automationRun->getStatus() !== AutomationRun::STATUS_RUNNING) { |
| 128 | throw Exceptions::automationRunNotRunning($runId, $automationRun->getStatus()); |
| 129 | } |
| 130 | |
| 131 | $automation = $this->automationStorage->getAutomation($automationRun->getAutomationId(), $automationRun->getVersionId()); |
| 132 | if (!$automation) { |
| 133 | throw Exceptions::automationVersionNotFound($automationRun->getAutomationId(), $automationRun->getVersionId()); |
| 134 | } |
| 135 | |
| 136 | if (!in_array($automation->getStatus(), [Automation::STATUS_ACTIVE, Automation::STATUS_DEACTIVATING], true)) { |
| 137 | throw Exceptions::automationNotActive($automationRun->getAutomationId()); |
| 138 | } |
| 139 | |
| 140 | $stepData = $automation->getStep($stepId); |
| 141 | if (!$stepData) { |
| 142 | throw Exceptions::automationStepNotFound($stepId); |
| 143 | } |
| 144 | |
| 145 | $logger->logStepData($stepData); |
| 146 | |
| 147 | $step = $this->registry->getStep($stepData->getKey()); |
| 148 | if (!$step instanceof Action) { |
| 149 | throw new InvalidStateException(); |
| 150 | } |
| 151 | |
| 152 | $requiredSubjects = $step->getSubjectKeys(); |
| 153 | $subjectEntries = $this->getSubjectEntries($automationRun, $requiredSubjects); |
| 154 | $args = new StepRunArgs($automation, $automationRun, $stepData, $subjectEntries, $runNumber); |
| 155 | $validationArgs = new StepValidationArgs($automation, $stepData, array_map(function (SubjectEntry $entry) { |
| 156 | return $entry->getSubject(); |
| 157 | }, $subjectEntries)); |
| 158 | |
| 159 | $step->validate($validationArgs); |
| 160 | $step->run($args, $this->stepRunControllerFactory->createController($args, $logger)); |
| 161 | |
| 162 | // check if run is not completed by now (e.g., one of if/else branches is empty) |
| 163 | $automationRun = $this->automationRunStorage->getAutomationRun($runId); |
| 164 | if ($automationRun && $automationRun->getStatus() !== AutomationRun::STATUS_RUNNING) { |
| 165 | $logger->logSuccess(); |
| 166 | return; |
| 167 | } |
| 168 | |
| 169 | // schedule next step if not scheduled by action |
| 170 | if (!$this->stepScheduler->hasScheduledStep($args)) { |
| 171 | $this->stepScheduler->scheduleNextStep($args); |
| 172 | } |
| 173 | |
| 174 | // logging |
| 175 | if ($this->stepScheduler->hasScheduledProgress($args)) { |
| 176 | $logger->logProgress(); |
| 177 | } else { |
| 178 | $logger->logSuccess(); |
| 179 | } |
| 180 | } |
| 181 | |
| 182 | /** @return SubjectEntry<Subject<Payload>>[] */ |
| 183 | private function getSubjectEntries(AutomationRun $automationRun, array $requiredSubjectKeys): array { |
| 184 | $subjectDataMap = []; |
| 185 | foreach ($automationRun->getSubjects() as $data) { |
| 186 | $subjectDataMap[$data->getKey()] = array_merge($subjectDataMap[$data->getKey()] ?? [], [$data]); |
| 187 | } |
| 188 | |
| 189 | $subjectEntries = []; |
| 190 | foreach ($requiredSubjectKeys as $key) { |
| 191 | $subjectData = $subjectDataMap[$key] ?? null; |
| 192 | if (!$subjectData) { |
| 193 | throw Exceptions::subjectDataNotFound($key, $automationRun->getId()); |
| 194 | } |
| 195 | } |
| 196 | foreach ($subjectDataMap as $subjectData) { |
| 197 | foreach ($subjectData as $data) { |
| 198 | $subjectEntries[] = $this->subjectLoader->getSubjectEntry($data); |
| 199 | } |
| 200 | } |
| 201 | return $subjectEntries; |
| 202 | } |
| 203 | |
| 204 | private function postProcessAutomationRun(int $automationRunId): void { |
| 205 | $automationRun = $this->automationRunStorage->getAutomationRun($automationRunId); |
| 206 | if (!$automationRun) { |
| 207 | return; |
| 208 | } |
| 209 | $automation = $this->automationStorage->getAutomation($automationRun->getAutomationId()); |
| 210 | if (!$automation) { |
| 211 | return; |
| 212 | } |
| 213 | $this->postProcessAutomation($automation); |
| 214 | } |
| 215 | |
| 216 | private function postProcessAutomation(Automation $automation): void { |
| 217 | if ($automation->getStatus() === Automation::STATUS_DEACTIVATING) { |
| 218 | $activeRuns = $this->automationRunStorage->getCountForAutomation($automation, AutomationRun::STATUS_RUNNING); |
| 219 | |
| 220 | // Set a deactivating Automation to draft once all automation runs are finished. |
| 221 | if ($activeRuns === 0) { |
| 222 | $automation->setStatus(Automation::STATUS_DRAFT); |
| 223 | $this->automationStorage->updateAutomation($automation); |
| 224 | } |
| 225 | } |
| 226 | } |
| 227 | } |
| 228 |