Prunable Models (laravel-workflow#182)

rmcdaniel · web-flow · commit be2663cf6759 · 2024-05-24T09:03:25.000-05:00
diff --git a/src/Models/StoredWorkflow.php b/src/Models/StoredWorkflow.php
@@ -4,6 +4,8 @@
 
 namespace Workflow\Models;
 
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Prunable;
 use Spatie\ModelStates\HasStates;
 use Workflow\States\WorkflowStatus;
 use Workflow\WorkflowStub;
@@ -14,6 +16,7 @@
 class StoredWorkflow extends Model
 {
     use HasStates;
+    use Prunable;
 
     /**
      * @var string
@@ -78,4 +81,39 @@ public function children(): \Illuminate\Database\Eloquent\Relations\BelongsToMan
             'child_workflow_id'
         )->withPivot(['parent_index', 'parent_now']);
     }
+
+    public function prunable(): Builder
+    {
+        return static::where('status', 'completed')
+            ->where('created_at', '<=', now()->sub(config('workflows.prune_age', '1 month')))
+            ->whereDoesntHave('parents');
+    }
+
+    protected function pruning(): void
+    {
+        $this->recursivePrune($this);
+    }
+
+    protected function recursivePrune(self $workflow): void
+    {
+        $workflow->children()
+            ->each(function ($child) {
+                $this->recursivePrune($child);
+            });
+
+        $workflow->parents()
+            ->detach();
+        $workflow->exceptions()
+            ->delete();
+        $workflow->logs()
+            ->delete();
+        $workflow->signals()
+            ->delete();
+        $workflow->timers()
+            ->delete();
+
+        if ($workflow->id !== $this->id) {
+            $workflow->delete();
+        }
+    }
 }
diff --git a/src/config/workflows.php b/src/config/workflows.php
@@ -19,6 +19,8 @@
 
     'workflow_relationships_table' => 'workflow_relationships',
 
+    'prune_age' => '1 month',
+
     'monitor' => env('WORKFLOW_MONITOR', false),
 
     'monitor_url' => env('WORKFLOW_MONITOR_URL'),
diff --git a/tests/Unit/Models/StoredWorkflowTest.php b/tests/Unit/Models/StoredWorkflowTest.php
@@ -4,6 +4,7 @@
 
 namespace Tests\Unit\Models;
 
+use Illuminate\Support\Carbon;
 use Tests\TestCase;
 use Workflow\Models\StoredWorkflow;
 
@@ -13,6 +14,7 @@ public function testModel(): void
     {
         $workflow = StoredWorkflow::create([
             'class' => 'class',
+            'status' => 'completed',
         ]);
 
         $workflow->exceptions()
@@ -39,9 +41,33 @@ public function testModel(): void
                 'stop_at' => now(),
             ]);
 
+        $workflow->children()
+            ->create([
+                'class' => 'class',
+                'status' => 'completed',
+            ], [
+                'parent_index' => 0,
+                'parent_now' => now(),
+            ]);
+
         $this->assertSame(1, $workflow->exceptions()->count());
         $this->assertSame(1, $workflow->logs()->count());
         $this->assertSame(1, $workflow->signals()->count());
         $this->assertSame(1, $workflow->timers()->count());
+        $this->assertSame(1, $workflow->children()->count());
+
+        Carbon::setTestNow(now()->addMonth()->addSecond());
+
+        $this->artisan('model:prune', [
+            '--model' => 'Workflow\Models\StoredWorkflow',
+        ])
+            ->doesntExpectOutputToContain('No prunable models found.')
+            ->assertExitCode(0);
+
+        $this->assertSame(0, $workflow->exceptions()->count());
+        $this->assertSame(0, $workflow->logs()->count());
+        $this->assertSame(0, $workflow->signals()->count());
+        $this->assertSame(0, $workflow->timers()->count());
+        $this->assertSame(0, $workflow->children()->count());
     }
 }
