refactor Task to native enum

spatie · Jun 12, 2024 · cfa484a · cfa484a
1 parent ef47b64
commit cfa484a
Show file tree

Hide file tree

Showing 21 changed files with 55 additions and 49 deletions.
diff --git a/src/Commands/MonitorBackupsCommand.php b/src/Commands/MonitorBackupsCommand.php
@@ -49,7 +49,7 @@ protected function checkSourcesHealth(): self
             $this->error("Source `{$source->name}` is unhealthy");
 
             foreach ($failureMessages as $failureMessage) {
-                $source->logError(Task::MONITOR, $failureMessage);
+                $source->logError(Task::Monitor, $failureMessage);
             }
 
             $source->update(['healthy' => false]);
@@ -79,7 +79,7 @@ protected function checkDestinationsHealth(): self
             $this->error("Destination `{$destination->name}` is unhealthy");
 
             foreach ($failureMessages as $failureMessage) {
-                $destination->logError(Task::MONITOR, $failureMessage);
+                $destination->logError(Task::Monitor, $failureMessage);
             }
 
             event(new UnhealthyDestinationFoundEvent($destination, $failureMessages));

diff --git a/src/Models/Backup.php b/src/Models/Backup.php
@@ -112,7 +112,7 @@ public function markAsInProgress(): self
 
     public function markAsCompleted(): self
     {
-        $this->logInfo(Task::BACKUP, 'Backup completed.');
+        $this->logInfo(Task::Backup, 'Backup completed.');
 
         $this->update([
             'status' => BackupStatus::Completed,
@@ -124,7 +124,7 @@ public function markAsCompleted(): self
 
     public function markAsFailed(string $errorMessage): self
     {
-        $this->logError(Task::BACKUP, "Backup failed: {$errorMessage}");
+        $this->logError(Task::Backup, "Backup failed: {$errorMessage}");
 
         $this->update([
             'status' => BackupStatus::Failed,
@@ -146,7 +146,7 @@ public function scopeFailed(Builder $query): void
     public function handleProgress(string $type, string $progressOutput): self
     {
         if ($type === Process::ERR) {
-            $this->logError(Task::BACKUP, $progressOutput);
+            $this->logError(Task::Backup, $progressOutput);
 
             return $this;
         }
@@ -162,7 +162,7 @@ public function handleProgress(string $type, string $progressOutput): self
         return $this;
     }
 
-    protected function addMessageToLog(string $task, string $level, string $message): Backup
+    protected function addMessageToLog(Task $task, string $level, string $message): Backup
     {
         $this->logItems()->create([
             'source_id' => $this->source_id,

diff --git a/src/Models/BackupLogItem.php b/src/Models/BackupLogItem.php
@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Spatie\BackupServer\Support\Helpers\Enums\Task;
 
 class BackupLogItem extends Model
 {
@@ -14,6 +15,10 @@ class BackupLogItem extends Model
 
     protected $guarded = [];
 
+    protected $casts = [
+        'task' => Task::class,
+    ];
+
     public function source(): BelongsTo
     {
         return $this->belongsTo(Source::class);

diff --git a/src/Models/Concerns/LogsActivity.php b/src/Models/Concerns/LogsActivity.php
@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Spatie\BackupServer\Models\BackupLogItem;
 use Spatie\BackupServer\Support\Helpers\Enums\LogLevel;
+use Spatie\BackupServer\Support\Helpers\Enums\Task;
 
 trait LogsActivity
 {
@@ -13,15 +14,15 @@ public function logItems(): HasMany
         return $this->hasMany(BackupLogItem::class);
     }
 
-    public function logInfo(string $task, string $text): void
+    public function logInfo(Task $task, string $text): void
     {
         $this->addMessageToLog($task, LogLevel::INFO, $text);
     }
 
-    public function logError(string $task, string $text): void
+    public function logError(Task $task, string $text): void
     {
         $this->addMessageToLog($task, LogLevel::ERROR, $text);
     }
 
-    abstract protected function addMessageToLog(string $task, string $level, string $message);
+    abstract protected function addMessageToLog(Task $task, string $level, string $message);
 }
diff --git a/src/Models/Destination.php b/src/Models/Destination.php
@@ -11,6 +11,7 @@
 use Spatie\BackupServer\Models\Concerns\HasAsyncDelete;
 use Spatie\BackupServer\Models\Concerns\HasBackupRelation;
 use Spatie\BackupServer\Models\Concerns\LogsActivity;
+use Spatie\BackupServer\Support\Helpers\Enums\Task;
 use Spatie\BackupServer\Tasks\Cleanup\Jobs\DeleteDestinationJob;
 use Spatie\BackupServer\Tasks\Monitor\HealthCheckCollection;
 use Spatie\BackupServer\Tests\Database\Factories\DestinationFactory;
@@ -64,7 +65,7 @@ public function reachable(): bool
         }
     }
 
-    protected function addMessageToLog(string $task, string $level, string $message): void
+    protected function addMessageToLog(Task $task, string $level, string $message): void
     {
         $this->logItems()->create([
             'task' => $task,

diff --git a/src/Models/Source.php b/src/Models/Source.php
@@ -9,6 +9,7 @@
 use Spatie\BackupServer\Models\Concerns\HasAsyncDelete;
 use Spatie\BackupServer\Models\Concerns\HasBackupRelation;
 use Spatie\BackupServer\Models\Concerns\LogsActivity;
+use Spatie\BackupServer\Support\Helpers\Enums\Task;
 use Spatie\BackupServer\Tasks\Cleanup\Jobs\DeleteSourceJob;
 use Spatie\BackupServer\Tasks\Monitor\HealthCheckCollection;
 use Spatie\BackupServer\Tests\Database\Factories\SourceFactory;
@@ -102,7 +103,7 @@ public function scopeUnhealthy(Builder $query): void
         $query->where('healthy', false);
     }
 
-    protected function addMessageToLog(string $task, string $level, string $message): Source
+    protected function addMessageToLog(Task $task, string $level, string $message): Source
     {
         $this->logItems()->create([
             'destination_id' => $this->destination_id,

diff --git a/src/Support/Helpers/Enums/Task.php b/src/Support/Helpers/Enums/Task.php
@@ -2,11 +2,9 @@
 
 namespace Spatie\BackupServer\Support\Helpers\Enums;
 
-class Task
+enum Task: string
 {
-    public const BACKUP = 'backup';
-
-    public const CLEANUP = 'cleanup';
-
-    public const MONITOR = 'monitor';
+    case Backup = 'backup';
+    case Cleanup = 'cleanup';
+    case Monitor = 'monitor';
 }
diff --git a/src/Tasks/Backup/Actions/CreateBackupAction.php b/src/Tasks/Backup/Actions/CreateBackupAction.php
@@ -42,7 +42,7 @@ public function execute(Source $source): Backup
             ($this->afterBackupModelCreated)($backup);
         }
 
-        $backup->logInfo(Task::BACKUP, 'Dispatching backup job...');
+        $backup->logInfo(Task::Backup, 'Dispatching backup job...');
 
         $job = (new PerformBackupJob($backup));
 

diff --git a/src/Tasks/Backup/Jobs/BackupTasks/CalculateBackupSize.php b/src/Tasks/Backup/Jobs/BackupTasks/CalculateBackupSize.php
@@ -9,7 +9,7 @@ class CalculateBackupSize implements BackupTask
 {
     public function execute(Backup $backup): void
     {
-        $backup->logInfo(Task::BACKUP, 'Calculating backup size...');
+        $backup->logInfo(Task::Backup, 'Calculating backup size...');
 
         $backup->recalculateBackupSize();
 

diff --git a/src/Tasks/Backup/Jobs/BackupTasks/Concerns/ExecutesBackupCommands.php b/src/Tasks/Backup/Jobs/BackupTasks/Concerns/ExecutesBackupCommands.php
@@ -18,17 +18,17 @@ public function executeBackupCommands(Backup $backup, string $commandAttributeNa
 
         $label = str_replace('_', ' ', $commandAttributeName);
 
-        $backup->logInfo(Task::BACKUP, "Performing {$label}...");
+        $backup->logInfo(Task::Backup, "Performing {$label}...");
 
         /** @var \Symfony\Component\Process\Process $process */
         $process = $backup->source->executeSshCommands($commands);
 
         if (! $process->isSuccessful()) {
-            $backup->logError(Task::BACKUP, $label.' error output:'.PHP_EOL.$process->getErrorOutput());
+            $backup->logError(Task::Backup, $label.' error output:'.PHP_EOL.$process->getErrorOutput());
 
             throw BackupFailed::BackupCommandsFailed($backup, $commandAttributeName, $process->getErrorOutput());
         }
 
-        $backup->logInfo(Task::BACKUP, $label.' output:'.PHP_EOL.$process->getOutput());
+        $backup->logInfo(Task::Backup, $label.' output:'.PHP_EOL.$process->getOutput());
     }
 }
diff --git a/src/Tasks/Backup/Jobs/BackupTasks/DetermineDestinationPath.php b/src/Tasks/Backup/Jobs/BackupTasks/DetermineDestinationPath.php
@@ -10,7 +10,7 @@ class DetermineDestinationPath implements BackupTask
 {
     public function execute(Backup $backup): void
     {
-        $backup->logInfo(Task::BACKUP, 'Determining destination directory...');
+        $backup->logInfo(Task::Backup, 'Determining destination directory...');
 
         $directory = $backup->destination->directory.$backup->source->id.'/backup-'.$backup->created_at->format('Y-m-d-His').'/';
 

diff --git a/src/Tasks/Backup/Jobs/BackupTasks/EnsureDestinationIsReachable.php b/src/Tasks/Backup/Jobs/BackupTasks/EnsureDestinationIsReachable.php
@@ -10,7 +10,7 @@ class EnsureDestinationIsReachable implements BackupTask
 {
     public function execute(Backup $backup): void
     {
-        $backup->logInfo(Task::BACKUP, 'Ensuring destination is reachable...');
+        $backup->logInfo(Task::Backup, 'Ensuring destination is reachable...');
 
         if (! $backup->destination->reachable()) {
             throw BackupFailed::destinationNotReachable($backup);

diff --git a/src/Tasks/Backup/Jobs/BackupTasks/EnsureSourceIsReachable.php b/src/Tasks/Backup/Jobs/BackupTasks/EnsureSourceIsReachable.php
@@ -10,7 +10,7 @@ class EnsureSourceIsReachable implements BackupTask
 {
     public function execute(Backup $backup): void
     {
-        $backup->logInfo(Task::BACKUP, 'Ensuring source is reachable...');
+        $backup->logInfo(Task::Backup, 'Ensuring source is reachable...');
 
         $process = $backup->source->executeSshCommands(['whoami']);
 

diff --git a/src/Tasks/Backup/Jobs/BackupTasks/RunBackup.php b/src/Tasks/Backup/Jobs/BackupTasks/RunBackup.php
@@ -13,7 +13,7 @@ class RunBackup implements BackupTask
 {
     public function execute(Backup $backup): void
     {
-        $backup->logInfo(Task::BACKUP, 'Running backup...');
+        $backup->logInfo(Task::Backup, 'Running backup...');
 
         $pendingBackup = (new PendingBackup())
             ->from($backup->sourceLocation())
@@ -87,7 +87,7 @@ protected function saveRsyncSummary(Backup $backup, string $output)
 
         $summary = substr($output, $startingPosition);
 
-        $backup->logInfo(Task::BACKUP, trim($summary));
+        $backup->logInfo(Task::Backup, trim($summary));
 
         $backup->update([
             'rsync_summary' => trim($summary),

diff --git a/src/Tasks/Cleanup/Jobs/PerformCleanupDestinationJob.php b/src/Tasks/Cleanup/Jobs/PerformCleanupDestinationJob.php
@@ -37,18 +37,18 @@ public function __construct(public Destination $destination)
 
     public function handle(): void
     {
-        $this->destination->logInfo(Task::CLEANUP, 'Starting cleanup of destination');
+        $this->destination->logInfo(Task::Cleanup, 'Starting cleanup of destination');
 
         //TODO: implement
 
-        $this->destination->logInfo(Task::CLEANUP, 'Destination cleaned up');
+        $this->destination->logInfo(Task::Cleanup, 'Destination cleaned up');
 
         event(new CleanupForDestinationCompletedEvent($this->destination));
     }
 
     public function failed(Throwable $exception): void
     {
-        $this->destination->logError(Task::CLEANUP, "Error while cleaning up destination `{$this->destination->name}`: `{$exception->getMessage()}`");
+        $this->destination->logError(Task::Cleanup, "Error while cleaning up destination `{$this->destination->name}`: `{$exception->getMessage()}`");
 
         event(new CleanupForDestinationFailedEvent($this->destination, $exception->getMessage()));
     }

diff --git a/src/Tasks/Cleanup/Jobs/PerformCleanupSourceJob.php b/src/Tasks/Cleanup/Jobs/PerformCleanupSourceJob.php
@@ -39,7 +39,7 @@ public function __construct(public Source $source)
 
     public function handle(): void
     {
-        $this->source->logInfo(Task::CLEANUP, 'Starting cleanup...');
+        $this->source->logInfo(Task::Cleanup, 'Starting cleanup...');
 
         $tasks = [
             DeleteBackupsWithoutDirectoriesFromDb::class,
@@ -54,12 +54,12 @@ public function handle(): void
 
         event(new CleanupForSourceCompletedEvent($this->source));
 
-        $this->source->logInfo(Task::CLEANUP, 'Cleanup done!');
+        $this->source->logInfo(Task::Cleanup, 'Cleanup done!');
     }
 
     public function failed(Throwable $exception): void
     {
-        $this->source->logError(Task::CLEANUP, "Error while cleaning up source `{$this->source->name}`: `{$exception->getMessage()}`");
+        $this->source->logError(Task::Cleanup, "Error while cleaning up source `{$this->source->name}`: `{$exception->getMessage()}`");
 
         report($exception);
 

diff --git a/src/Tasks/Cleanup/Jobs/Tasks/DeleteBackupsWithoutDirectoriesFromDb.php b/src/Tasks/Cleanup/Jobs/Tasks/DeleteBackupsWithoutDirectoriesFromDb.php
@@ -14,7 +14,7 @@ public function execute(Source $source): void
             ->completedBackups()
             ->each(function (Backup $backup) {
                 if (! $backup->existsOnDisk()) {
-                    $backup->source->logInfo(Task::CLEANUP, "Removing backup id `{$backup->id}` because its directory `{$backup->destinationLocation()->getPath()}` on disk `{$backup->disk_name}` does not exist anymore ");
+                    $backup->source->logInfo(Task::Cleanup, "Removing backup id `{$backup->id}` because its directory `{$backup->destinationLocation()->getPath()}` on disk `{$backup->disk_name}` does not exist anymore ");
                     $backup->delete();
                 }
             });

diff --git a/src/Tasks/Cleanup/Jobs/Tasks/DeleteFailedBackups.php b/src/Tasks/Cleanup/Jobs/Tasks/DeleteFailedBackups.php
@@ -15,7 +15,7 @@ public function execute(Source $source): void
             ->get()
             ->filter(fn (Backup $backup) => $backup->created_at->diffInDays() > 1)
             ->each(function (Backup $backup) use ($source) {
-                $source->logInfo(Task::CLEANUP, "Removing backup id {$backup->id} because it has failed");
+                $source->logInfo(Task::Cleanup, "Removing backup id {$backup->id} because it has failed");
 
                 $backup->delete();
             });

diff --git a/src/Tasks/Cleanup/Jobs/Tasks/RecalculateRealBackupSizes.php b/src/Tasks/Cleanup/Jobs/Tasks/RecalculateRealBackupSizes.php
@@ -9,7 +9,7 @@ class RecalculateRealBackupSizes implements CleanupTask
 {
     public function execute(Source $source): void
     {
-        $source->logInfo(Task::CLEANUP, 'Recalculating real backup sizes...');
+        $source->logInfo(Task::Cleanup, 'Recalculating real backup sizes...');
 
         /** @var \Spatie\BackupServer\Tasks\Backup\Support\BackupCollection $backupCollection */
         $backupCollection = $source->completedBackups()->get();

diff --git a/src/Tasks/Cleanup/Strategies/DefaultCleanupStrategy.php b/src/Tasks/Cleanup/Strategies/DefaultCleanupStrategy.php
@@ -120,7 +120,7 @@ protected function removeOldBackupsUntilUsingLessThanMaximumStorage(BackupCollec
         /** @var \Spatie\BackupServer\Models\Backup $oldestBackup */
         $oldestBackup = $backups->oldest();
 
-        $oldestBackup->logInfo(Task::CLEANUP, 'Deleting backup because destination uses more space than the limit allows');
+        $oldestBackup->logInfo(Task::Cleanup, 'Deleting backup because destination uses more space than the limit allows');
 
         $oldestBackup->delete();
 

diff --git a/tests/Unit/Models/Concerns/LogsActivityTest.php b/tests/Unit/Models/Concerns/LogsActivityTest.php
@@ -10,71 +10,71 @@
 test('a source can log activity', function () {
     $source = Source::factory()->create();
 
-    $source->logInfo(Task::BACKUP, 'info for backup task');
+    $source->logInfo(Task::Backup, 'info for backup task');
     $this->assertDatabaseHas('backup_server_backup_log', [
         'source_id' => $source->id,
         'backup_id' => null,
         'destination_id' => $source->destination->id,
         'level' => LogLevel::INFO,
-        'task' => Task::BACKUP,
+        'task' => Task::Backup,
         'message' => 'info for backup task',
     ]);
 
-    $source->logError(Task::CLEANUP, 'error for cleanup task');
+    $source->logError(Task::Cleanup, 'error for cleanup task');
     $this->assertDatabaseHas('backup_server_backup_log', [
         'source_id' => $source->id,
         'backup_id' => null,
         'destination_id' => $source->destination->id,
         'level' => LogLevel::ERROR,
-        'task' => Task::CLEANUP,
+        'task' => Task::Cleanup,
         'message' => 'error for cleanup task',
     ]);
 });
 
 test('a backup can log activity', function () {
     $backup = Backup::factory()->make();
 
-    $backup->logInfo(Task::BACKUP, 'info for backup task');
+    $backup->logInfo(Task::Backup, 'info for backup task');
     $this->assertDatabaseHas('backup_server_backup_log', [
         'source_id' => $backup->source->id,
         'backup_id' => $backup->id,
         'destination_id' => $backup->destination->id,
         'level' => LogLevel::INFO,
-        'task' => Task::BACKUP,
+        'task' => Task::Backup,
         'message' => 'info for backup task',
     ]);
 
-    $backup->logError(Task::CLEANUP, 'error for cleanup task');
+    $backup->logError(Task::Cleanup, 'error for cleanup task');
     $this->assertDatabaseHas('backup_server_backup_log', [
         'source_id' => $backup->source->id,
         'backup_id' => $backup->id,
         'destination_id' => $backup->destination->id,
         'level' => LogLevel::ERROR,
-        'task' => Task::CLEANUP,
+        'task' => Task::Cleanup,
         'message' => 'error for cleanup task',
     ]);
 });
 
 test('a destination can log activity', function () {
     $destination = Destination::factory()->create();
 
-    $destination->logInfo(Task::BACKUP, 'info for backup task');
+    $destination->logInfo(Task::Backup, 'info for backup task');
     $this->assertDatabaseHas('backup_server_backup_log', [
         'source_id' => null,
         'backup_id' => null,
         'destination_id' => $destination->id,
         'level' => LogLevel::INFO,
-        'task' => Task::BACKUP,
+        'task' => Task::Backup,
         'message' => 'info for backup task',
     ]);
 
-    $destination->logError(Task::CLEANUP, 'error for cleanup task');
+    $destination->logError(Task::Cleanup, 'error for cleanup task');
     $this->assertDatabaseHas('backup_server_backup_log', [
         'source_id' => null,
         'backup_id' => null,
         'destination_id' => $destination->id,
         'level' => LogLevel::ERROR,
-        'task' => Task::CLEANUP,
+        'task' => Task::Cleanup,
         'message' => 'error for cleanup task',
     ]);
 });