optimize warning output

Author: wol-soft

src/State/ExecutionLog/ExecutionLog.php

@@ -18,7 +18,10 @@ class ExecutionLog
     private array $stepInfo = [];
     /** @var string[][] Collect all warnings which occurred during the workflow execution */
     private array $warnings = [];
+    private int $warningsDuringStep = 0;
+
     private float $startAt;
+
     private WorkflowState $workflowState;
 
     public function __construct(WorkflowState $workflowState)
@@ -29,8 +32,9 @@ public function __construct(WorkflowState $workflowState)
     public function addStep(int $stage, string $step, string $state, ?string $reason): void {
         $stage = $this->mapStage($stage);
 
-        $this->stages[$stage][] = new Step($step, $state, $reason, $this->stepInfo);
+        $this->stages[$stage][] = new Step($step, $state, $reason, $this->stepInfo, $this->warningsDuringStep);
         $this->stepInfo = [];
+        $this->warningsDuringStep = 0;
     }
 
     public function __toString(): string
@@ -56,6 +60,7 @@ public function attachStepInfo(string $info): void
     public function addWarning(string $message): void
     {
         $this->warnings[$this->mapStage($this->workflowState->getStage())][] = $message;
+        $this->warningsDuringStep++;
     }
 
     public function startExecution(): void
@@ -68,11 +73,15 @@ public function stopExecution(): void
         $this->attachStepInfo("Execution time: " . number_format(1000 * (microtime(true) - $this->startAt), 5) . 'ms');
 
         if ($this->warnings) {
-            $warnings = "Got " . count($this->warnings, COUNT_RECURSIVE) . " warnings during the execution:\n";
+            $warnings = sprintf(
+                "Got %s warning%s during the execution:\n        ",
+                $amount = count($this->warnings, COUNT_RECURSIVE) - count($this->warnings),
+                $amount > 1 ? 's' : '',
+            );
 
             foreach ($this->warnings as $stage => $stageWarnings) {
                 $warnings .= implode(
-                    "\n    ",
+                    "\n        ",
                     array_map(
                         fn (string $warning): string => sprintf("%s: %s", $stage, $warning),
                         $stageWarnings,

src/State/ExecutionLog/Step.php

@@ -10,18 +10,22 @@ class Step
     private string $state;
     private ?string $reason;
     private array $stepInfo;
+    private int $warnings;
 
-    public function __construct(string $step, string $state, ?string $reason, array $stepInfo)
+    public function __construct(string $step, string $state, ?string $reason, array $stepInfo, int $warnings)
     {
         $this->step = $step;
         $this->state = $state;
         $this->reason = $reason;
         $this->stepInfo = $stepInfo;
+        $this->warnings = $warnings;
     }
 
     public function __toString(): string
     {
-        $stepLog = "{$this->step}: {$this->state}" . ($this->reason ? " ({$this->reason})" : '');
+        $stepLog = "{$this->step}: {$this->state}" .
+            ($this->reason ? " ({$this->reason})" : '') .
+            ($this->warnings ? " ({$this->warnings} warning" . ($this->warnings > 1 ? 's' : '') . ")" : '');
 
         foreach ($this->stepInfo as $info) {
             $stepLog .= "\n    - $info";

src/WorkflowControl.php

@@ -4,6 +4,7 @@
 
 namespace PHPWorkflow;
 
+use Exception;
 use PHPWorkflow\Exception\WorkflowControl\FailStepException;
 use PHPWorkflow\Exception\WorkflowControl\FailWorkflowException;
 use PHPWorkflow\Exception\WorkflowControl\SkipStepException;
@@ -80,9 +81,21 @@ public function attachStepInfo(string $info): void
      * All warnings will be collected and shown in the workflow debug log.
      *
      * @param string $message
+     * @param Exception|null $exception An exception causing the warning
+     *                                  (if provided exception information will be added to the warning)
      */
-    public function warning(string $message): void
+    public function warning(string $message, ?Exception $exception = null): void
     {
+        if ($exception) {
+            $message .= sprintf(
+                " (%s%s in %s::%s)",
+                trim(strrchr(get_class($exception), '\\'), '\\'),
+                ($exception->getMessage() ? ": {$exception->getMessage()}" : ''),
+                $exception->getFile(),
+                $exception->getLine(),
+            );
+        }
+
         $this->executionLog->addWarning($message);
     }
 }