add before and after

Author: QuentinGab

src/Models/Workflow.php

@@ -10,8 +10,6 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Support\Collection as SupportCollection;
-use Illuminate\Support\Facades\Bus;
-use Throwable;
 
 /**
  * @property int $id
@@ -245,86 +243,30 @@ public function markStepAsCanceled(string $name): static
         return $this;
     }
 
-    public function run(
-        ?string $connection = null,
-        ?string $queue = null,
-    ): void {
-        /** @var ?string $connection */
-        $connection = $connection ?? config('workflow.queue_connection');
-        /** @var ?string $queue */
-        $queue = $queue ?? config('workflow.queue');
-
+    public function run(): void
+    {
         if (
             $this->isFinished() ||
             $this->isFailed() ||
-            $this->isCanceled() ||
-            ! $this->definition->shouldRun()
+            $this->isCanceled()
         ) {
             return;
         }
 
-        if ($this->definition->shouldCancel()) {
+        if ($this->definition->shouldCancel($this)) {
             $this->markAsCanceled();
 
             return;
         }
 
-        $readySteps = $this->definition
-            ->steps($this)
-            ->filter(function ($step, $name) {
-                return ! $this->isStepPending($name) &&
-                    ! $this->isStepFinished($name) &&
-                    ! $this->isStepCanceled($name) &&
-                    ! $this->isStepFailed($name) &&
-                    $step->isReady();
-            });
-
-        if ($readySteps->isEmpty()) {
+        if (! $this->definition->shouldRun($this)) {
             return;
         }
 
-        $items = $this->items()->createMany(
-            $readySteps->map(fn ($step, $name) => [
-                'name' => $name,
-                'dispatched_at' => now(),
-            ])
-        );
-
-        $this->items->push(...$items);
+        $this->definition->beforeRun($this);
 
-        /**
-         * @var array<int, string> $stepNames
-         */
-        $stepNames = $readySteps->keys()->toArray();
-        $workflowId = $this->id;
+        $this->definition->run($this);
 
-        Bus::chain([
-            ...$readySteps->flatMap(function ($step, $name) use ($workflowId) {
-                return [
-                    $step->action,
-                    function () use ($workflowId, $name) {
-                        $workflow = Workflow::query()->findOrFail($workflowId);
-                        $workflow->markStepAsFinished($name);
-                    },
-                ];
-            }),
-        ])
-            ->catch(function (Throwable $e) use ($workflowId, $stepNames) {
-                $workflow = Workflow::query()->findOrFail($workflowId);
-
-                $item = $workflow
-                    ->items
-                    ->whereIn('name', $stepNames)
-                    ->firstWhere('finished_at', null);
-
-                if ($item) {
-                    $workflow->markStepAsFailed($item->name);
-                } else {
-                    $workflow->markAsFailed();
-                }
-            })
-            ->onConnection($connection)
-            ->onQueue($queue)
-            ->dispatch();
+        $this->definition->afterRun($this);
     }
 }

src/WorkflowDefinition.php

@@ -5,6 +5,8 @@
 use Elegantly\Workflow\Models\Workflow;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Bus;
+use Throwable;
 
 abstract class WorkflowDefinition
 {
@@ -28,13 +30,89 @@ public function start(): Workflow
         return $workflow;
     }
 
-    public function shouldCancel(): bool
+    public function shouldCancel(Workflow $workflow): bool
     {
         return false;
     }
 
-    public function shouldRun(): bool
+    public function shouldRun(Workflow $workflow): bool
     {
         return true;
     }
+
+    public function beforeRun(Workflow $workflow): void
+    {
+        //
+    }
+
+    public function run(Workflow $workflow): void
+    {
+        $readySteps = $this
+            ->steps($workflow)
+            ->filter(function ($step, $name) use ($workflow) {
+                return ! $workflow->isStepPending($name) &&
+                    ! $workflow->isStepFinished($name) &&
+                    ! $workflow->isStepCanceled($name) &&
+                    ! $workflow->isStepFailed($name) &&
+                    $step->isReady();
+            });
+
+        if ($readySteps->isEmpty()) {
+            return;
+        }
+
+        $items = $workflow->items()->createMany(
+            $readySteps->map(fn ($step, $name) => [
+                'name' => $name,
+                'dispatched_at' => now(),
+            ])
+        );
+
+        $workflow->items->push(...$items);
+
+        /**
+         * @var array<int, string> $stepNames
+         */
+        $stepNames = $readySteps->keys()->toArray();
+        $workflowId = $workflow->id;
+
+        /** @var ?string $connection */
+        $connection = config('workflow.queue_connection');
+        /** @var ?string $queue */
+        $queue = config('workflow.queue');
+
+        Bus::chain([
+            ...$readySteps->flatMap(function ($step, $name) use ($workflowId) {
+                return [
+                    $step->action,
+                    function () use ($workflowId, $name) {
+                        $workflow = Workflow::query()->findOrFail($workflowId);
+                        $workflow->markStepAsFinished($name);
+                    },
+                ];
+            }),
+        ])
+            ->catch(function (Throwable $e) use ($workflowId, $stepNames) {
+                $workflow = Workflow::query()->findOrFail($workflowId);
+
+                $item = $workflow
+                    ->items
+                    ->whereIn('name', $stepNames)
+                    ->firstWhere('finished_at', null);
+
+                if ($item) {
+                    $workflow->markStepAsFailed($item->name);
+                } else {
+                    $workflow->markAsFailed();
+                }
+            })
+            ->onConnection($connection)
+            ->onQueue($queue)
+            ->dispatch();
+    }
+
+    public function afterRun(Workflow $workflow): void
+    {
+        //
+    }
 }