Skip to content

A self-hosted media server and file management system

feat: job for purging stale guest data

aminnausine2c68d1b7b2b
diff --git a/app/Jobs/Maintenance/PurgeStaleGuestData.php b/app/Jobs/Maintenance/PurgeStaleGuestData.php
new file mode 100644
index 00000000..1121fd90
--- /dev/null
+++ b/app/Jobs/Maintenance/PurgeStaleGuestData.php
@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Jobs\Maintenance;
+
+use App\Enums\TaskStatus;
+use App\Jobs\ManagedSubTask;
+use App\Models\SubTask;
+use App\Services\TaskService;
+use Illuminate\Support\Facades\DB;
+
+class PurgeStaleGuestData extends ManagedSubTask {
+ private array $tables = [
+ 'playback_progress',
+ ];
+
+ /**
+ * Create a new job instance.
+ *
+ * @return void
+ */
+ public function __construct(
+ int $taskId,
+ ) {
+ $subTask = SubTask::create(['task_id' => $taskId, 'status' => TaskStatus::PENDING, 'name' => 'Purge Stale Guest Data']);
+
+ $this->taskId = $taskId;
+ $this->subTaskId = $subTask->id;
+ }
+
+ public function handle(TaskService $taskService) {
+ if (! $this->beginSubTask($taskService)) {
+ return;
+ }
+
+ try {
+ $expiry = now()->subDays(30);
+
+ foreach ($this->tables as $table) {
+ DB::table($table)
+ ->whereNotNull('guest_token')
+ ->where('updated_at', '<', $expiry)
+ ->delete();
+ }
+
+ $this->completeSubTask($taskService, 'Purged Expired Guest Data');
+ } catch (\Throwable $th) {
+ $this->failSubTask($taskService, $th);
+ throw $th;
+ }
+ }
+}
diff --git a/app/Jobs/Maintenance/ScheduledPurgeStaleData.php b/app/Jobs/Maintenance/ScheduledPurgeStaleData.php
new file mode 100644
index 00000000..1551ce30
--- /dev/null
+++ b/app/Jobs/Maintenance/ScheduledPurgeStaleData.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Jobs\Maintenance;
+
+use App\Services\FileJobService;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Foundation\Queue\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class ScheduledPurgeStaleData implements ShouldQueue {
+ use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+ /**
+ * Execute the job.
+ */
+ public function handle(FileJobService $fileJobService): void {
+ $fileJobService->purgeStaleData(['userId' => null, 'namePrefix' => 'Scheduled ']);
+ }
+}
diff --git a/app/Services/FileJobService.php b/app/Services/FileJobService.php
index b6bed359..cea2acfe 100644
--- a/app/Services/FileJobService.php
+++ b/app/Services/FileJobService.php
@@ -6,6 +6,7 @@ use App\Enums\TaskStatus;
use App\Jobs\EmbedUidInMetadata;
use App\Jobs\GeneratePreviewImage;
use App\Jobs\IndexFiles;
+use App\Jobs\Maintenance\PurgeStaleGuestData;
use App\Jobs\SyncFiles;
use App\Jobs\Utility\Paths\CleanFolderPaths;
use App\Jobs\Utility\Paths\CleanVideoPaths;
@@ -238,6 +239,22 @@ class FileJobService {
);
}
+ public function purgeStaleData(array $data) {
+ $name = 'Purge Stale Data';
+ $description = 'Purges stale data older than 30 days such as guest data.';
+
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: ($data['namePrefix'] ?? '') . $name,
+ description: $description,
+ chain: function ($task) {
+ return [
+ new PurgeStaleGuestData($task->id),
+ ];
+ },
+ );
+ }
+
public function executeBatchOperation(
?int $userId,
string $name,
diff --git a/routes/console.php b/routes/console.php
index 128be79e..93be5e17 100755
--- a/routes/console.php
+++ b/routes/console.php
@@ -1,9 +1,12 @@
<?php
+use App\Jobs\Maintenance\ScheduledPurgeStaleData;
use App\Jobs\ScheduledIndexFiles;
use Illuminate\Support\Facades\Schedule;
Schedule::job(new ScheduledIndexFiles)->twiceDaily()->withoutOverlapping()->environments(['staging', 'production']);
+Schedule::job(new ScheduledPurgeStaleData)->daily()->withoutOverlapping();
+
Schedule::command('auth:clear-resets')->everyFifteenMinutes();
Schedule::command('sanctum:prune-expired --hours=2')->daily();