[Feature] Audit Purging

app-modules/assist-data-model/src/Models/Student.php

@@ -64,7 +64,7 @@ public function engagementFiles(): MorphToMany
             table: 'engagement_file_entities',
             foreignPivotKey: 'entity_id',
             relatedPivotKey: 'engagement_file_id',
-            relation: 'student',
+            relation: 'engagementFiles',
         );
     }
 }

app-modules/audit/database/migrations/2023_08_16_025823_create_audit_settings.php

@@ -6,7 +6,7 @@
 return new class () extends SettingsMigration {
     public function up(): void
     {
-        $this->migrator->add('audit.retention_duration', 129600);
+        $this->migrator->add('audit.retention_duration_in_days', 90);
         $this->migrator->add('audit.audited_models', AuditableModels::all()->keys());
     }
 };

app-modules/audit/src/Console/Commands/PurgePastRetentionAuditRecordsCommand.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Assist\Audit\Console\Commands;
+
+use Assist\Audit\Models\Audit;
+use Illuminate\Console\Command;
+use Assist\Audit\Settings\AuditSettings;
+
+class PurgePastRetentionAuditRecordsCommand extends Command
+{
+    protected $signature = 'audit:purge-past-retention-audit-records';
+
+    protected $description = 'Purge Audit records that are older than the retention duration.';
+
+    public function handle(AuditSettings $auditSettings): void
+    {
+        Audit::whereDate(
+            column: 'created_at',
+            operator: '<',
+            value: now()->subDays($auditSettings->retention_duration_in_days)
+        )->delete();
+    }
+}

app-modules/audit/src/Filament/Pages/ManageAuditSettings.php

@@ -6,6 +6,7 @@
 use Filament\Pages\SettingsPage;
 use Filament\Forms\Components\Select;
 use Assist\Audit\Settings\AuditSettings;
+use Filament\Forms\Components\TextInput;
 use Assist\Audit\Actions\Finders\AuditableModels;
 
 class ManageAuditSettings extends SettingsPage
@@ -20,7 +21,27 @@ public function form(Form $form): Form
             ->schema([
                 Select::make('audited_models')
                     ->options(AuditableModels::all())
-                    ->multiple(),
+                    ->multiple()
+                    ->in(AuditableModels::all()->keys()->toArray())
+                    ->rules(
+                        [
+                            'array',
+                        ]
+                    )
+                    ->hintIcon(
+                        icon: 'heroicon-m-question-mark-circle',
+                        tooltip: 'Items added here will be tracked by the audit trail.'
+                    ),
+                TextInput::make('retention_duration_in_days')
+                    ->label('Retention Duration')
+                    ->integer()
+                    ->minValue(1)
+                    ->step(1)
+                    ->suffix('Day/s')
+                    ->hintIcon(
+                        icon: 'heroicon-m-question-mark-circle',
+                        tooltip: 'Audit trail records older than the retention duration will be deleted.'
+                    ),
             ]);
     }
 }

app-modules/audit/src/Overrides/Concerns/AttachOverrides.php

@@ -2,6 +2,7 @@
 
 namespace Assist\Audit\Overrides\Concerns;
 
+use ReflectionClass;
 use Illuminate\Support\Facades\Event;
 use OwenIt\Auditing\Events\AuditCustom;
 use OwenIt\Auditing\Contracts\Auditable;
@@ -12,6 +13,13 @@ public function attach($id, array $attributes = [], $touch = true)
     {
         /** @var Auditable $parentModel */
         $parentModel = $this->getParent();
+
+        if (! $this->isAuditable($parentModel::class)) {
+            parent::attach($id, $attributes, $touch);
+
+            return;
+        }
+
         $relationName = $this->relationName;
 
         $parentModel->auditEvent = 'attach';
@@ -33,6 +41,11 @@ public function detach($ids = null, $touch = true)
     {
         /** @var Auditable $parentModel */
         $parentModel = $this->getParent();
+
+        if (! $this->isAuditable($parentModel::class)) {
+            return parent::detach($ids, $touch);
+        }
+
         $relationName = $this->relationName;
 
         $parentModel->auditEvent = 'detach';
@@ -56,6 +69,11 @@ public function sync($ids, $detaching = true)
     {
         /** @var Auditable $parentModel */
         $parentModel = $this->getParent();
+
+        if (! $this->isAuditable($parentModel::class)) {
+            return parent::sync($ids, $detaching);
+        }
+
         $relationName = $this->relationName;
 
         $parentModel->auditEvent = 'sync';
@@ -81,4 +99,11 @@ public function sync($ids, $detaching = true)
 
         return $changes;
     }
+
+    private function isAuditable(string $class)
+    {
+        $reflection = new ReflectionClass($class);
+
+        return $reflection->implementsInterface(Auditable::class);
+    }
 }

app-modules/audit/src/Providers/AuditServiceProvider.php

@@ -6,6 +6,7 @@
 use Assist\Audit\AuditPlugin;
 use Assist\Audit\Models\Audit;
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Console\Scheduling\Schedule;
 use Assist\Authorization\AuthorizationRoleRegistry;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Assist\Authorization\AuthorizationPermissionRegistry;
@@ -47,5 +48,12 @@ public function boot(AuthorizationPermissionRegistry $permissionRegistry, Author
             module: 'audit',
             path: 'roles/web'
         );
+
+        $this->callAfterResolving(Schedule::class, function (Schedule $schedule) {
+            $schedule->command('audit:purge-past-retention-audit-records')
+                ->daily()
+                ->evenInMaintenanceMode()
+                ->onOneServer();
+        });
     }
 }

app-modules/audit/src/Settings/AuditSettings.php

@@ -6,7 +6,7 @@
 
 class AuditSettings extends Settings
 {
-    public int $retention_duration;
+    public int $retention_duration_in_days;
 
     public array $audited_models;
 

app-modules/audit/tests/PurgePastRetentionAuditRecordsCommandTest.php

@@ -0,0 +1,62 @@
+<?php
+
+use Assist\Audit\Models\Audit;
+
+use function Pest\Laravel\artisan;
+use function Pest\Laravel\travelTo;
+
+use Illuminate\Support\Facades\Event;
+use Assist\Audit\Settings\AuditSettings;
+use Illuminate\Console\Events\ScheduledTaskStarting;
+
+test('PurgePastRetentionAuditRecordsCommand properly deletes records', function () {
+    $auditSettings = resolve(AuditSettings::class);
+    $auditSettings->retention_duration_in_days = 90;
+    $auditSettings->save();
+
+    $retainedAudits = Audit::factory()
+        ->count(5)
+        ->create(
+            [
+                'created_at' => now()->subDays(30),
+            ]
+        );
+
+    $purgedAudits = Audit::factory()
+        ->count(5)
+        ->create(
+            [
+                'created_at' => now()->subDays(100),
+            ]
+        );
+
+    $auditCount = Audit::count();
+
+    artisan('audit:purge-past-retention-audit-records');
+
+    expect(Audit::count())->toBe($auditCount - $purgedAudits->count());
+
+    $retainedAudits->each(
+        function ($audit) {
+            expect(Audit::where('id', $audit->id)->exists())->toBeTrue();
+        }
+    );
+
+    $purgedAudits->each(
+        function ($audit) {
+            expect(Audit::where('id', $audit->id)->exists())->toBeFalse();
+        }
+    );
+});
+
+test('PurgePastRetentionAuditRecordsCommand is properly scheduled', function () {
+    Event::fake();
+
+    travelTo(now()->startOfDay());
+
+    artisan('schedule:run');
+
+    Event::assertDispatched(function (ScheduledTaskStarting $event) {
+        return str($event->task->command)->contains('audit:purge-past-retention-audit-records');
+    });
+});

app-modules/engagement/src/Models/EngagementFile.php

@@ -73,7 +73,7 @@ public function students(): MorphToMany
             table: 'engagement_file_entities',
             foreignPivotKey: 'engagement_file_id',
             relatedPivotKey: 'entity_id',
-            relation: 'student',
+            relation: 'engagementFiles',
         );
     }
 

app/Filament/Resources/UserResource/RelationManagers/RolesRelationManager.php

@@ -3,13 +3,9 @@
 namespace App\Filament\Resources\UserResource\RelationManagers;
 
 use Filament\Forms\Form;
-use Illuminate\View\View;
 use Filament\Tables\Table;
-use Filament\Actions\Action;
 use Filament\Tables\Columns\TextColumn;
 use Filament\Forms\Components\TextInput;
-use Assist\Authorization\Enums\ModelHasRolesViaEnum;
-use Assist\Authorization\Events\RoleRemovedFromUser;
 use Filament\Resources\RelationManagers\RelationManager;
 
 class RolesRelationManager extends RelationManager