Add basic loop implementation

wol-soft · Nov 2, 2021 · 4e33c32 · 4e33c32
1 parent 75051b9
commit 4e33c32
Show file tree

Hide file tree

Showing 11 changed files with 564 additions and 275 deletions.
diff --git a/src/Stage/Next/AllowNextExecuteWorkflow.php b/src/Stage/Next/AllowNextExecuteWorkflow.php
@@ -49,10 +49,10 @@ public function executeWorkflow(
             );
 
             if ($exception instanceof SkipWorkflowException) {
-                return new WorkflowResult($workflowState->getWorkflowName(), true, $workflowState);
+                return $workflowState->close(true);
             }
 
-            $result = new WorkflowResult($workflowState->getWorkflowName(), false, $workflowState, $exception);
+            $result = $workflowState->close(false, $exception);
 
             if ($throwOnFailure) {
                 throw new WorkflowException(
@@ -65,6 +65,6 @@ public function executeWorkflow(
             return $result;
         }
 
-        return new WorkflowResult($workflowState->getWorkflowName(), true, $workflowState);
+        return $workflowState->close(true);
     }
 }
diff --git a/src/Stage/Stage.php b/src/Stage/Stage.php
@@ -4,17 +4,14 @@
 
 namespace PHPWorkflow\Stage;
 
-use Exception;
-use PHPWorkflow\Exception\WorkflowControl\FailStepException;
-use PHPWorkflow\Exception\WorkflowControl\SkipStepException;
-use PHPWorkflow\Exception\WorkflowControl\SkipWorkflowException;
-use PHPWorkflow\State\ExecutionLog\ExecutionLog;
 use PHPWorkflow\State\WorkflowState;
-use PHPWorkflow\Step\WorkflowStep;
+use PHPWorkflow\Step\StepExecutionTrait;
 use PHPWorkflow\Workflow;
 
 abstract class Stage
 {
+    use StepExecutionTrait;
+
     protected ?Stage $nextStage = null;
     protected Workflow $workflow;
 
@@ -24,61 +21,4 @@ public function __construct(Workflow $workflow)
     }
 
     abstract protected function runStage(WorkflowState $workflowState): ?Stage;
-
-    protected function wrapStepExecution(WorkflowStep $step, WorkflowState $workflowState): void {
-        try {
-            ($this->resolveMiddleware($step, $workflowState))();
-        } catch (SkipStepException | FailStepException $exception) {
-            $workflowState->addExecutionLog(
-                $step->getDescription(),
-                $exception instanceof FailStepException ? ExecutionLog::STATE_FAILED : ExecutionLog::STATE_SKIPPED,
-                $exception->getMessage(),
-            );
-
-            if ($exception instanceof FailStepException) {
-                // cancel the workflow during preparation
-                if ($workflowState->getStage() <= WorkflowState::STAGE_PROCESS) {
-                    throw $exception;
-                }
-
-                $workflowState->getExecutionLog()->addWarning(sprintf('Step failed (%s)', get_class($step)), true);
-            }
-
-            return;
-        } catch (Exception $exception) {
-            $workflowState->addExecutionLog(
-                $step->getDescription(),
-                $exception instanceof SkipWorkflowException ? ExecutionLog::STATE_SKIPPED : ExecutionLog::STATE_FAILED,
-                $exception->getMessage(),
-            );
-
-            // cancel the workflow during preparation
-            if ($workflowState->getStage() <= WorkflowState::STAGE_PROCESS) {
-                throw $exception;
-            }
-
-            if (!($exception instanceof SkipWorkflowException)) {
-                $workflowState->getExecutionLog()->addWarning(sprintf('Step failed (%s)', get_class($step)), true);
-            }
-
-            return;
-        }
-
-        $workflowState->addExecutionLog($step->getDescription());
-    }
-
-    private function resolveMiddleware(WorkflowStep $step, WorkflowState $workflowState): callable
-    {
-        $tip = fn () => $step->run($workflowState->getWorkflowControl(), $workflowState->getWorkflowContainer());
-
-        foreach ($workflowState->getMiddlewares() as $middleware) {
-            $tip = fn () => $middleware(
-                $tip,
-                $workflowState->getWorkflowControl(),
-                $workflowState->getWorkflowContainer(),
-            );
-        }
-
-        return $tip;
-    }
 }
diff --git a/src/State/WorkflowResult.php b/src/State/WorkflowResult.php
@@ -5,23 +5,26 @@
 namespace PHPWorkflow\State;
 
 use Exception;
+use PHPWorkflow\State\ExecutionLog\ExecutionLog;
 
 class WorkflowResult
 {
     private bool $success;
-    private WorkflowState $workflowState;
     private ?Exception $exception;
     private string $workflowName;
+    private ExecutionLog $executionLog;
+    private WorkflowContainer $workflowContainer;
 
     public function __construct(
-        string $workflowName,
-        bool $success,
         WorkflowState $workflowState,
+        bool $success,
         ?Exception $exception = null
     ) {
-        $this->workflowName = $workflowName;
+        $this->workflowName = $workflowState->getWorkflowName();
+        $this->executionLog = $workflowState->getExecutionLog();
+        $this->workflowContainer = $workflowState->getWorkflowContainer();
+
         $this->success = $success;
-        $this->workflowState = $workflowState;
         $this->exception = $exception;
     }
 
@@ -46,15 +49,15 @@ public function success(): bool
      */
     public function debug(): string
     {
-        return (string) $this->workflowState->getExecutionLog();
+        return (string) $this->executionLog;
     }
 
     /**
      * Check if the workflow execution has triggered warnings
      */
     public function hasWarnings(): bool
     {
-        return count($this->workflowState->getExecutionLog()->getWarnings()) > 0;
+        return count($this->executionLog->getWarnings()) > 0;
     }
 
     /**
@@ -65,7 +68,7 @@ public function hasWarnings(): bool
      */
     public function getWarnings(): array
     {
-        return $this->workflowState->getExecutionLog()->getWarnings();
+        return $this->executionLog->getWarnings();
     }
 
     /**
@@ -82,6 +85,6 @@ public function getException(): ?Exception
      */
     public function getContainer(): WorkflowContainer
     {
-        return $this->workflowState->getWorkflowContainer();
+        return $this->workflowContainer;
     }
 }
diff --git a/src/State/WorkflowState.php b/src/State/WorkflowState.php
@@ -28,11 +28,27 @@ class WorkflowState
     private string $workflowName;
     private array $middlewares = [];
 
+    private static array $runningWorkflows = [];
+
     public function __construct(WorkflowContainer $workflowContainer)
     {
         $this->executionLog = new ExecutionLog($this);
         $this->workflowControl = new WorkflowControl($this->executionLog);
         $this->workflowContainer = $workflowContainer;
+
+        self::$runningWorkflows[] = $this;
+    }
+
+    public function close(bool $success, ?Exception $exception = null): WorkflowResult
+    {
+        array_pop(self::$runningWorkflows);
+
+        return new WorkflowResult($this, $success, $exception);
+    }
+
+    public static function getRunningWorkflow(): ?self
+    {
+        return self::$runningWorkflows ? end(self::$runningWorkflows) : null;
     }
 
     public function getProcessException(): ?Exception

diff --git a/src/Step/Loop.php b/src/Step/Loop.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPWorkflow\Step;
+
+use PHPWorkflow\State\WorkflowContainer;
+use PHPWorkflow\State\WorkflowState;
+use PHPWorkflow\WorkflowControl;
+
+class Loop implements WorkflowStep
+{
+    use StepExecutionTrait;
+
+    protected array $steps = [];
+    protected LoopControl $loopControl;
+
+    public function __construct(LoopControl $loopControl)
+    {
+        $this->loopControl = $loopControl;
+    }
+
+    public function addStep(WorkflowStep $step): self
+    {
+        $this->steps[] = $step;
+
+        return $this;
+    }
+
+    public function getDescription(): string
+    {
+        return $this->loopControl->getDescription();
+    }
+
+    public function run(WorkflowControl $control, WorkflowContainer $container)
+    {
+        $iteration = 0;
+
+        while ($this->loopControl->executeNextIteration($iteration, $control, $container)) {
+            foreach ($this->steps as $step) {
+                $this->wrapStepExecution($step, WorkflowState::getRunningWorkflow());
+            }
+
+            WorkflowState::getRunningWorkflow()->addExecutionLog(sprintf("Loop iteration #%s", ++$iteration));
+        }
+
+        $control->attachStepInfo(sprintf("Loop finished after %s iterations", $iteration));
+    }
+}
diff --git a/src/Step/LoopControl.php b/src/Step/LoopControl.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPWorkflow\Step;
+
+use PHPWorkflow\State\WorkflowContainer;
+use PHPWorkflow\WorkflowControl;
+
+interface LoopControl
+{
+    /**
+     * Describe in a few words what this loop does
+     */
+    public function getDescription(): string;
+
+    /**
+     * Return true if the next iteration of the loop shall be executed. Return false to break the loop
+     */
+    public function executeNextIteration(int $iteration, WorkflowControl $control, WorkflowContainer $container): bool;
+}
diff --git a/src/Step/StepExecutionTrait.php b/src/Step/StepExecutionTrait.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPWorkflow\Step;
+
+use Exception;
+use PHPWorkflow\Exception\WorkflowControl\FailStepException;
+use PHPWorkflow\Exception\WorkflowControl\SkipStepException;
+use PHPWorkflow\Exception\WorkflowControl\SkipWorkflowException;
+use PHPWorkflow\State\ExecutionLog\ExecutionLog;
+use PHPWorkflow\State\WorkflowState;
+
+trait StepExecutionTrait
+{
+    protected function wrapStepExecution(WorkflowStep $step, WorkflowState $workflowState): void {
+        try {
+            ($this->resolveMiddleware($step, $workflowState))();
+        } catch (SkipStepException | FailStepException $exception) {
+            $workflowState->addExecutionLog(
+                $step->getDescription(),
+                $exception instanceof FailStepException ? ExecutionLog::STATE_FAILED : ExecutionLog::STATE_SKIPPED,
+                $exception->getMessage(),
+            );
+
+            if ($exception instanceof FailStepException) {
+                // cancel the workflow during preparation
+                if ($workflowState->getStage() <= WorkflowState::STAGE_PROCESS) {
+                    throw $exception;
+                }
+
+                $workflowState->getExecutionLog()->addWarning(sprintf('Step failed (%s)', get_class($step)), true);
+            }
+
+            return;
+        } catch (Exception $exception) {
+            $workflowState->addExecutionLog(
+                $step->getDescription(),
+                $exception instanceof SkipWorkflowException ? ExecutionLog::STATE_SKIPPED : ExecutionLog::STATE_FAILED,
+                $exception->getMessage(),
+            );
+
+            // cancel the workflow during preparation
+            if ($workflowState->getStage() <= WorkflowState::STAGE_PROCESS) {
+                throw $exception;
+            }
+
+            if (!($exception instanceof SkipWorkflowException)) {
+                $workflowState->getExecutionLog()->addWarning(sprintf('Step failed (%s)', get_class($step)), true);
+            }
+
+            return;
+        }
+
+        $workflowState->addExecutionLog($step->getDescription());
+    }
+
+    private function resolveMiddleware(WorkflowStep $step, WorkflowState $workflowState): callable
+    {
+        $tip = fn () => $step->run($workflowState->getWorkflowControl(), $workflowState->getWorkflowContainer());
+
+        foreach ($workflowState->getMiddlewares() as $middleware) {
+            $tip = fn () => $middleware(
+                $tip,
+                $workflowState->getWorkflowControl(),
+                $workflowState->getWorkflowContainer(),
+            );
+        }
+
+        return $tip;
+    }
+}