Extract logging logic to a service, make logs mutable

[MAILPOET-5568]
2023-09-01 14:19:01 +02:00
parent 43c396220b
commit dd881d8b33
6 changed files with 155 additions and 33 deletions
--- a/mailpoet/lib/Automation/Engine/Control/StepRunLogger.php
+++ b/mailpoet/lib/Automation/Engine/Control/StepRunLogger.php
@ -0,0 +1,85 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Automation\Engine\Control;
+
+use DateTimeImmutable;
+use MailPoet\Automation\Engine\Data\AutomationRunLog;
+use MailPoet\Automation\Engine\Hooks;
+use MailPoet\Automation\Engine\Storage\AutomationRunLogStorage;
+use MailPoet\InvalidStateException;
+use Throwable;
+
+class StepRunLogger {
+  /** @var AutomationRunLogStorage */
+  private $automationRunLogStorage;
+
+  /** @var Hooks */
+  private $hooks;
+
+  /** @var int */
+  private $runId;
+
+  /** @var string */
+  private $stepId;
+
+  /** @var AutomationRunLog|null */
+  private $log;
+
+  public function __construct(
+    AutomationRunLogStorage $automationRunLogStorage,
+    Hooks $hooks,
+    int $runId,
+    string $stepId
+  ) {
+    $this->automationRunLogStorage = $automationRunLogStorage;
+    $this->hooks = $hooks;
+    $this->runId = $runId;
+    $this->stepId = $stepId;
+  }
+
+  public function logStart(): void {
+    $this->getLog();
+  }
+
+  public function logSuccess(): void {
+    $log = $this->getLog();
+    $log->setStatus(AutomationRunLog::STATUS_COMPLETE);
+    $log->setCompletedAt(new DateTimeImmutable());
+    $this->triggerAfterRunHook($log);
+    $this->automationRunLogStorage->updateAutomationRunLog($log);
+  }
+
+  public function logFailure(Throwable $error): void {
+    $log = $this->getLog();
+    $log->setStatus(AutomationRunLog::STATUS_FAILED);
+    $log->setError($error);
+    $log->setCompletedAt(new DateTimeImmutable());
+    $this->triggerAfterRunHook($log);
+    $this->automationRunLogStorage->updateAutomationRunLog($log);
+  }
+
+  private function getLog(): AutomationRunLog {
+    if (!$this->log) {
+      $this->log = $this->automationRunLogStorage->getAutomationRunLogByRunAndStepId($this->runId, $this->stepId);
+    }
+
+    if (!$this->log) {
+      $log = new AutomationRunLog($this->runId, $this->stepId);
+      $id = $this->automationRunLogStorage->createAutomationRunLog($log);
+      $this->log = $this->automationRunLogStorage->getAutomationRunLog($id);
+    }
+
+    if (!$this->log) {
+      throw new InvalidStateException('Failed to create automation run log');
+    }
+    return $this->log;
+  }
+
+  private function triggerAfterRunHook(AutomationRunLog $log): void {
+    try {
+      $this->hooks->doAutomationStepAfterRun($log);
+    } catch (Throwable $e) {
+      // ignore integration errors
+    }
+  }
+}