Merge pull request #8748 from ProcessMaker/task/FOUR-29115

Add cases_retention_policy_logs Table and Logging for Case Deletions

Author: sanjacornelius

ProcessMaker/Jobs/EvaluateProcessRetentionJob.php

@@ -9,6 +9,7 @@
 use ProcessMaker\Http\Controllers\Api\Actions\Cases\DeletesCaseRecords;
 use ProcessMaker\Models\CaseNumber;
 use ProcessMaker\Models\CaseParticipated;
+use ProcessMaker\Models\CaseRetentionPolicyLog;
 use ProcessMaker\Models\CaseStarted;
 use ProcessMaker\Models\Process;
 use ProcessMaker\Models\ProcessRequest;
@@ -139,6 +140,8 @@ public function handle(): void
         CaseNumber::whereIn('process_request_id', $processRequestSubquery)
             ->where($this->buildRetentionQuery($retentionUpdatedAt, $oldCasesCutoff, $newCasesCutoff))
             ->chunkById(100, function ($cases) use (&$processRequestIdsToDelete, &$totalDeleted, &$chunkCount) {
+                $chunkStartTime = microtime(true);
+
                 $caseIds = $cases->pluck('id')->all();
                 $processRequestIds = $cases->pluck('process_request_id')->unique()->all();
 
@@ -170,10 +173,21 @@ public function handle(): void
                 $chunkSize = count($caseIds);
                 $totalDeleted += $chunkSize;
 
+                $chunkTimeMs = round((microtime(true) - $chunkStartTime) * 1000, 2);
+
                 Log::info('EvaluateProcessRetentionJob: Deleted chunk of cases', [
                     'process_id' => $this->processId,
                     'chunk_number' => $chunkCount,
                     'cases_deleted' => $chunkSize,
+                    'deletion_time_ms' => $chunkTimeMs,
+                ]);
+
+                CaseRetentionPolicyLog::create([
+                    'process_id' => $this->processId,
+                    'case_ids' => json_encode($caseIds),
+                    'deleted_count' => $chunkSize,
+                    'total_time_taken' => $chunkTimeMs,
+                    'deleted_at' => Carbon::now(),
                 ]);
             });
 

ProcessMaker/Models/CaseRetentionPolicyLog.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseRetentionPolicyLog extends ProcessMakerModel
+{
+    use HasFactory;
+
+    protected $table = 'case_retention_policy_logs';
+
+    const UPDATED_AT = null;
+
+    protected $guarded = [
+        'id',
+        'created_at',
+    ];
+
+    protected $fillable = [
+        'process_id',
+        'case_ids',
+        'deleted_count',
+        'total_time_taken',
+        'deleted_at',
+    ];
+}

database/factories/ProcessMaker/Models/CaseRetentionPolicyLogFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Database\Factories\ProcessMaker\Models;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use ProcessMaker\Models\CaseNumber;
+use ProcessMaker\Models\Process;
+
+/**
+ * Model factory for a settings.
+ */
+class CaseRetentionPolicyLogFactory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            'process_id' => function () {
+                return Process::factory()->create()->id;
+            },
+            'case_ids' => json_encode(CaseNumber::factory()->count($this->faker->numberBetween(1, 1000))->create()->pluck('id')->toArray()),
+            'deleted_count' => $this->faker->numberBetween(1, 1000),
+            'total_time_taken' => $this->faker->numberBetween(1, 1000000),
+            'deleted_at' => $this->faker->dateTimeBetween('-1 year', 'now'),
+            'created_at' => $this->faker->dateTimeBetween('-1 year', 'now'),
+        ];
+    }
+}

database/migrations/2026_02_24_180143_case_retention_policy_logs.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('case_retention_policy_logs', function (Blueprint $table) {
+            $table->id();
+            $table->unsignedInteger('process_id');
+            $table->json('case_ids')->nullable();
+            $table->bigInteger('deleted_count')->default(0);
+
+            $table->bigInteger('total_time_taken')->nullable(); // in seconds
+            $table->timestamp('deleted_at')->nullable();
+            $table->timestamp('created_at')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('case_retention_policy_logs');
+    }
+};

tests/unit/ProcessMaker/Models/CaseRetentionPolicyLogTest.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Tests\Unit\ProcessMaker\Models;
+
+use Carbon\Carbon;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\DB;
+use ProcessMaker\Jobs\EvaluateProcessRetentionJob;
+use ProcessMaker\Models\CaseNumber;
+use ProcessMaker\Models\CaseParticipated;
+use ProcessMaker\Models\CaseRetentionPolicyLog;
+use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Models\Process;
+use ProcessMaker\Models\ProcessRequest;
+use Tests\TestCase;
+
+class CaseRetentionPolicyLogTest extends TestCase
+{
+    use RefreshDatabase;
+
+    public function testJobAddsLogRecordWhenCasesAreDeleted(): void
+    {
+        Config::set('app.case_retention_policy_enabled', true);
+
+        $process = Process::factory()->create([
+            'properties' => ['retention_period' => 'one_year'],
+        ]);
+        $process->save();
+        $process->refresh();
+
+        $processRequest = ProcessRequest::factory()->create();
+        $processRequest->process_id = $process->id;
+        $processRequest->save();
+        $processRequest->refresh();
+
+        CaseNumber::where('process_request_id', $processRequest->id)->delete();
+
+        $oldCaseCreatedAt = Carbon::now()->subMonths(13)->toIso8601String();
+        $caseOld = CaseNumber::factory()->create([
+            'created_at' => $oldCaseCreatedAt,
+            'process_request_id' => $processRequest->id,
+        ]);
+        CaseStarted::factory()->create(['case_number' => $caseOld->id]);
+        CaseParticipated::factory()->create(['case_number' => $caseOld->id]);
+
+        $this->assertDatabaseCount('case_retention_policy_logs', 0);
+
+        EvaluateProcessRetentionJob::dispatchSync($process->id);
+
+        $this->assertDatabaseCount('case_retention_policy_logs', 1);
+
+        $log = CaseRetentionPolicyLog::first();
+        $this->assertSame((int) $process->id, (int) $log->process_id);
+        $this->assertSame(1, $log->deleted_count);
+        $this->assertNotEmpty($log->total_time_taken);
+        $this->assertIsNumeric($log->total_time_taken);
+        $this->assertNotNull($log->deleted_at);
+
+        $loggedCaseIds = json_decode($log->case_ids, true);
+        $this->assertIsArray($loggedCaseIds);
+        $this->assertContains((int) $caseOld->id, array_map('intval', $loggedCaseIds));
+
+        Config::set('app.case_retention_policy_enabled', false);
+    }
+}