Automation.php
2 months ago
AutomationRun.php
1 year ago
AutomationRunLog.php
1 year ago
AutomationStatistics.php
9 months ago
AutomationTemplate.php
6 months ago
AutomationTemplateCategory.php
2 years ago
Field.php
2 years ago
Filter.php
3 years ago
FilterGroup.php
2 months ago
Filters.php
2 months ago
NextStep.php
2 years ago
Step.php
2 months ago
StepRunArgs.php
2 years ago
StepValidationArgs.php
3 years ago
Subject.php
3 years ago
SubjectEntry.php
3 years ago
index.php
3 years ago
AutomationRunLog.php
217 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Automation\Engine\Data; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use DateTimeImmutable; |
| 9 | use InvalidArgumentException; |
| 10 | use MailPoet\Automation\Engine\Utils\Json; |
| 11 | use Throwable; |
| 12 | |
| 13 | class AutomationRunLog { |
| 14 | public const STATUS_RUNNING = 'running'; |
| 15 | public const STATUS_COMPLETE = 'complete'; |
| 16 | public const STATUS_FAILED = 'failed'; |
| 17 | |
| 18 | public const STATUS_ALL = [ |
| 19 | self::STATUS_RUNNING, |
| 20 | self::STATUS_COMPLETE, |
| 21 | self::STATUS_FAILED, |
| 22 | ]; |
| 23 | |
| 24 | public const TYPE_ACTION = 'action'; |
| 25 | public const TYPE_TRIGGER = 'trigger'; |
| 26 | |
| 27 | public const KEY_UNKNOWN = 'unknown'; |
| 28 | |
| 29 | /** @var int */ |
| 30 | private $id; |
| 31 | |
| 32 | /** @var int */ |
| 33 | private $automationRunId; |
| 34 | |
| 35 | /** @var string */ |
| 36 | private $stepId; |
| 37 | |
| 38 | /** @var string */ |
| 39 | private $stepType; |
| 40 | |
| 41 | /** @var string */ |
| 42 | private $stepKey; |
| 43 | |
| 44 | /** @var string */ |
| 45 | private $status; |
| 46 | |
| 47 | /** @var DateTimeImmutable */ |
| 48 | private $startedAt; |
| 49 | |
| 50 | /** @var DateTimeImmutable */ |
| 51 | private $updatedAt; |
| 52 | |
| 53 | /** @var int */ |
| 54 | private $runNumber = 1; |
| 55 | |
| 56 | /** @var array */ |
| 57 | private $data = []; |
| 58 | |
| 59 | /** @var array|null */ |
| 60 | private $error; |
| 61 | |
| 62 | public function __construct( |
| 63 | int $automationRunId, |
| 64 | string $stepId, |
| 65 | string $stepType, |
| 66 | ?int $id = null |
| 67 | ) { |
| 68 | $this->automationRunId = $automationRunId; |
| 69 | $this->stepId = $stepId; |
| 70 | $this->stepType = $stepType; |
| 71 | $this->stepKey = self::KEY_UNKNOWN; |
| 72 | $this->status = self::STATUS_RUNNING; |
| 73 | |
| 74 | $now = new DateTimeImmutable(); |
| 75 | $this->startedAt = $now; |
| 76 | $this->updatedAt = $now; |
| 77 | |
| 78 | if ($id) { |
| 79 | $this->id = $id; |
| 80 | } |
| 81 | } |
| 82 | |
| 83 | public function getId(): ?int { |
| 84 | return $this->id; |
| 85 | } |
| 86 | |
| 87 | public function getAutomationRunId(): int { |
| 88 | return $this->automationRunId; |
| 89 | } |
| 90 | |
| 91 | public function getStepId(): string { |
| 92 | return $this->stepId; |
| 93 | } |
| 94 | |
| 95 | public function getStepType(): string { |
| 96 | return $this->stepType; |
| 97 | } |
| 98 | |
| 99 | public function getStepKey(): string { |
| 100 | return $this->stepKey; |
| 101 | } |
| 102 | |
| 103 | public function setStepKey(string $stepKey): void { |
| 104 | $this->stepKey = $stepKey; |
| 105 | $this->updatedAt = new DateTimeImmutable(); |
| 106 | } |
| 107 | |
| 108 | public function getStatus(): string { |
| 109 | return $this->status; |
| 110 | } |
| 111 | |
| 112 | public function setStatus(string $status): void { |
| 113 | if (!in_array($status, self::STATUS_ALL, true)) { |
| 114 | throw new InvalidArgumentException("Invalid status '$status'."); |
| 115 | } |
| 116 | $this->status = $status; |
| 117 | $this->updatedAt = new DateTimeImmutable(); |
| 118 | } |
| 119 | |
| 120 | public function getStartedAt(): DateTimeImmutable { |
| 121 | return $this->startedAt; |
| 122 | } |
| 123 | |
| 124 | public function getUpdatedAt(): DateTimeImmutable { |
| 125 | return $this->updatedAt; |
| 126 | } |
| 127 | |
| 128 | public function getRunNumber(): int { |
| 129 | return $this->runNumber; |
| 130 | } |
| 131 | |
| 132 | public function setRunNumber(int $runNumber): void { |
| 133 | $this->runNumber = $runNumber; |
| 134 | } |
| 135 | |
| 136 | public function setUpdatedAt(DateTimeImmutable $updatedAt): void { |
| 137 | $this->updatedAt = $updatedAt; |
| 138 | } |
| 139 | |
| 140 | public function getData(): array { |
| 141 | return $this->data; |
| 142 | } |
| 143 | |
| 144 | /** @param mixed $value */ |
| 145 | public function setData(string $key, $value): void { |
| 146 | if (!$this->isDataStorable($value)) { |
| 147 | throw new InvalidArgumentException("Invalid data provided for key '$key'. Only scalar values and arrays of scalar values are allowed."); |
| 148 | } |
| 149 | $this->data[$key] = $value; |
| 150 | $this->updatedAt = new DateTimeImmutable(); |
| 151 | } |
| 152 | |
| 153 | public function getError(): ?array { |
| 154 | return $this->error; |
| 155 | } |
| 156 | |
| 157 | public function toArray(): array { |
| 158 | return [ |
| 159 | 'id' => $this->id, |
| 160 | 'automation_run_id' => $this->automationRunId, |
| 161 | 'step_id' => $this->stepId, |
| 162 | 'step_type' => $this->stepType, |
| 163 | 'step_key' => $this->stepKey, |
| 164 | 'status' => $this->status, |
| 165 | 'started_at' => $this->startedAt->format(DateTimeImmutable::W3C), |
| 166 | 'updated_at' => $this->updatedAt->format(DateTimeImmutable::W3C), |
| 167 | 'run_number' => $this->runNumber, |
| 168 | 'data' => Json::encode($this->data), |
| 169 | 'error' => $this->error ? Json::encode($this->error) : null, |
| 170 | ]; |
| 171 | } |
| 172 | |
| 173 | public function setError(Throwable $error): void { |
| 174 | // Normalize all nested objects in error trace to associative arrays. |
| 175 | // Empty objects would then get decoded to "[]" instead of "{}". |
| 176 | $trace = Json::decode(Json::encode($error->getTrace())); |
| 177 | $this->error = [ |
| 178 | 'message' => $error->getMessage(), |
| 179 | 'errorClass' => get_class($error), |
| 180 | 'code' => $error->getCode(), |
| 181 | 'trace' => $trace, |
| 182 | ]; |
| 183 | $this->updatedAt = new DateTimeImmutable(); |
| 184 | } |
| 185 | |
| 186 | public static function fromArray(array $data): self { |
| 187 | $log = new AutomationRunLog((int)$data['automation_run_id'], $data['step_id'], $data['step_type']); |
| 188 | $log->id = (int)$data['id']; |
| 189 | $log->stepKey = $data['step_key']; |
| 190 | $log->status = $data['status']; |
| 191 | $log->startedAt = new DateTimeImmutable($data['started_at']); |
| 192 | $log->updatedAt = new DateTimeImmutable($data['updated_at']); |
| 193 | $log->runNumber = (int)$data['run_number']; |
| 194 | $log->data = Json::decode($data['data']); |
| 195 | $log->error = isset($data['error']) ? Json::decode($data['error']) : null; |
| 196 | return $log; |
| 197 | } |
| 198 | |
| 199 | /** @param mixed $data */ |
| 200 | private function isDataStorable($data): bool { |
| 201 | if (is_scalar($data)) { |
| 202 | return true; |
| 203 | } |
| 204 | |
| 205 | if (!is_array($data)) { |
| 206 | return false; |
| 207 | } |
| 208 | |
| 209 | foreach ($data as $value) { |
| 210 | if (!$this->isDataStorable($value)) { |
| 211 | return false; |
| 212 | } |
| 213 | } |
| 214 | return true; |
| 215 | } |
| 216 | } |
| 217 |