fix: user getting logged out when doing backups or restores (#70)

Author: NeoIsRecursive

client/src/components/Backup.vue

@@ -26,7 +26,8 @@ export default {
     },
   },
   created() {
-    console.log(this.chunkSize)
+    // console.log(this.chunkSize)
+
     window.backup = {
       chunkSize: this.chunkSize
     };

composer.lock

@@ -4,6 +4,7 @@
 
 namespace Itiden\Backup;
 
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Pipeline;
 use Itiden\Backup\Contracts\Repositories\BackupRepository;
@@ -29,7 +30,7 @@ public function __construct(
      *
      * @throws Exceptions\BackupFailed
      */
-    public function backup(): BackupDto
+    public function backup(?Authenticatable $user = null): BackupDto
     {
         $lock = $this->stateManager->getLock();
 
@@ -61,8 +62,6 @@ public function backup(): BackupDto
 
             $metadata = static::addMetaFromZipToBackupMeta($temp_zip_path, $backup);
 
-            $user = auth()->user();
-
             if ($user) {
                 $metadata->setCreatedBy($user);
             }

src/Backuper.php

@@ -5,18 +5,22 @@
 namespace Itiden\Backup\Http\Controllers\Api;
 
 use Illuminate\Container\Attributes\Authenticated;
-use Illuminate\Contracts\Cache\Repository;
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Http\JsonResponse;
-use Itiden\Backup\Exceptions\ActionAlreadyInProgress;
 use Itiden\Backup\Jobs\RestoreJob;
 use Itiden\Backup\StateManager;
-use Statamic\Contracts\Auth\User;
 
 final readonly class RestoreController
 {
-    public function __invoke(string $id, StateManager $stateManager, #[Authenticated] User $user): JsonResponse
-    {
-        $stateManager->dispatch(new RestoreJob($id, $user));
+    public function __invoke(
+        string $id,
+        StateManager $stateManager,
+        #[Authenticated] Authenticatable $user,
+    ): JsonResponse {
+        $stateManager->dispatch(new RestoreJob(
+            id: $id,
+            user: $user,
+        ));
 
         return response()->json(['message' => __('statamic-backup::backup.restore.started')]);
     }

src/Http/Controllers/Api/RestoreController.php

@@ -5,16 +5,16 @@
 namespace Itiden\Backup\Http\Controllers\Api;
 
 use Illuminate\Container\Attributes\Authenticated;
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Http\JsonResponse;
 use Itiden\Backup\Jobs\BackupJob;
 use Itiden\Backup\StateManager;
-use Statamic\Contracts\Auth\User;
 
 final readonly class StoreBackupController
 {
-    public function __invoke(StateManager $stateManager, #[Authenticated] User $user): JsonResponse
+    public function __invoke(StateManager $stateManager, #[Authenticated] Authenticatable $user): JsonResponse
     {
-        $stateManager->dispatch(new BackupJob($user));
+        $stateManager->dispatch(new BackupJob(user: $user));
 
         return response()->json(['message' => __('statamic-backup::backup.backup_started')]);
     }

src/Http/Controllers/Api/StoreBackupController.php

@@ -4,12 +4,12 @@
 
 namespace Itiden\Backup\Jobs;
 
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Queue\Queueable;
 use Itiden\Backup\Backuper;
 use Itiden\Backup\StateManager;
-use Statamic\Contracts\Auth\User;
 
 final class BackupJob implements ShouldQueue
 {
@@ -19,17 +19,15 @@ final class BackupJob implements ShouldQueue
      * Create a new job instance.
      */
     public function __construct(
-        private User $user,
+        private Authenticatable $user,
     ) {}
 
     /**
      * Execute the job.
      */
     public function handle(Backuper $backuper, Repository $cache): void
     {
-        auth()->login($this->user); // ugly but it works;
-
-        $backuper->backup();
+        $backuper->backup(user: $this->user);
 
         $cache->forget(StateManager::JOB_QUEUED_KEY);
     }

src/Jobs/BackupJob.php

@@ -4,12 +4,12 @@
 
 namespace Itiden\Backup\Jobs;
 
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Queue\Queueable;
 use Itiden\Backup\Restorer;
 use Itiden\Backup\StateManager;
-use Statamic\Contracts\Auth\User;
 
 final class RestoreJob implements ShouldQueue
 {
@@ -20,17 +20,18 @@ final class RestoreJob implements ShouldQueue
      */
     public function __construct(
         private string $id,
-        private User $user,
+        private Authenticatable $user,
     ) {}
 
     /**
      * Execute the job.
      */
     public function handle(Restorer $backuper, Repository $cache): void
     {
-        auth()->login($this->user); // ugly but it works;
-
-        $backuper->restoreFromId($this->id);
+        $backuper->restoreFromId(
+            id: $this->id,
+            user: $this->user,
+        );
 
         $cache->forget(StateManager::JOB_QUEUED_KEY);
     }

src/Jobs/RestoreJob.php

@@ -5,6 +5,7 @@
 namespace Itiden\Backup;
 
 use Exception;
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Pipeline;
@@ -30,23 +31,23 @@ public function __construct(
      *
      * @throws Exception
      */
-    public function restoreFromId(string $id): void
+    public function restoreFromId(string $id, ?Authenticatable $user = null): void
     {
         $backup = $this->repository->find($id);
 
         if (!$backup) {
             throw new RuntimeException("Backup with id {$id} not found.");
         }
 
-        $this->restore($backup);
+        $this->restore($backup, $user);
     }
 
     /**
      * Restore to the given backup.
      *
      * @throws RestoreFailed
      */
-    public function restore(BackupDto $backup): void
+    public function restore(BackupDto $backup, ?Authenticatable $user = null): void
     {
         $lock = $this->stateManager->getLock();
 
@@ -70,7 +71,6 @@ public function restore(BackupDto $backup): void
 
             event(new BackupRestored($backup));
 
-            $user = auth()->user();
             if ($user) {
                 $backup->getMetadata()->addRestore($user);
             }