[Core]: Backup/restore #509

Activity

1. nielsdrost7

   assigned

   spacecabbie

   on Jun 13, 2026
2. nielsdrost7

   added a parent issue on Jun 13, 2026

   • [Core]: Epic — Module Core #3
3. nielsdrost7

   added this to the v2.0.0-alpha milestone on Jun 13, 2026
4. nielsdrost7

   added

   high-prio

   on Jul 3, 2026
5. nielsdrost7

   added

   refinedRefined with SMART plan / test suggestionsRefined with SMART plan / test suggestions

   on Jul 16, 2026
6. nielsdrost7 commented on Jul 16, 2026

   

   nielsdrost7

   on Jul 16, 2026

   CollaboratorAuthor

   More actions

   SMART Plan — Backup and restore

   Context/Epic: Core

   Specific

   Give administrators a way to create a full backup (database + uploaded files) and restore it, from within the admin panel. Current state: there is nothing here today — no spatie/laravel-backup (or any backup package) in composer.json, no backup-related code anywhere under Modules/, no console command, no Filament page. This is a from-scratch feature, not an extension of existing scaffolding.

   Measurable

   • A console command produces a single archive containing a database dump and the contents of the uploads disk.
     • PHPUnit: it_creates_a_backup_archive_containing_a_database_dump()

       #[Test]
       public function it_creates_a_backup_archive_containing_a_database_dump(): void
       {
           /* Arrange */
           Storage::fake('backups');
   
           /* Act */
           $this->artisan('ip:backup')->assertSuccessful();
   
           /* Assert */
           $files = Storage::disk('backups')->allFiles();
           $this->assertNotEmpty($files);
       }

   • Uploaded files (via the existing Upload model's storage disk) are included in the backup archive.
     • PHPUnit: it_includes_uploaded_files_in_the_backup_archive()

       #[Test]
       public function it_includes_uploaded_files_in_the_backup_archive(): void
       {
           /* Arrange */
           Storage::fake('backups');
           $upload = Upload::factory()->for($this->company)->create();
           Storage::disk($upload->upload_disk)->put($upload->upload_stored_name, 'fake-file-contents');
   
           /* Act */
           $this->artisan('ip:backup')->assertSuccessful();
   
           /* Assert */
           $backupFile = Storage::disk('backups')->allFiles()[0] ?? null;
           $this->assertNotNull($backupFile);
       }

   • Restoring a valid backup archive repopulates the database and file storage.
     • PHPUnit: it_restores_data_from_a_valid_backup_archive()

       #[Test]
       public function it_restores_data_from_a_valid_backup_archive(): void
       {
           /* Arrange */
           Storage::fake('backups');
           $this->artisan('ip:backup')->assertSuccessful();
           $archivePath = Storage::disk('backups')->allFiles()[0];
           Relation::query()->delete();
   
           /* Act */
           $this->artisan('ip:restore', ['archive' => $archivePath])->assertSuccessful();
   
           /* Assert */
           $this->assertGreaterThan(0, Relation::query()->count());
       }

   • Attempting to restore a corrupted/invalid archive fails loudly rather than partially applying.
     • PHPUnit: it_rejects_a_corrupted_backup_archive_without_modifying_data()

       #[Test]
       public function it_rejects_a_corrupted_backup_archive_without_modifying_data(): void
       {
           /* Arrange */
           Storage::fake('backups');
           Storage::disk('backups')->put('corrupt.zip', 'not-a-real-archive');
           $before = Relation::query()->count();
   
           /* Act */
           $this->artisan('ip:restore', ['archive' => 'corrupt.zip'])->assertFailed();
   
           /* Assert */
           $this->assertSame($before, Relation::query()->count());
       }

   • An administrator can trigger a backup and download the resulting file from the admin panel.
     • Frontend/Livewire: As a super admin I want to trigger a manual backup from the admin panel so I don't have to SSH into the server.

       #[Test]
       public function it_triggers_a_manual_backup_from_the_admin_panel(): void
       {
           /* Arrange */
           /* superAdmin provided by AbstractAdminPanelTestCase */
   
           /* Act */
           $component = Livewire::actingAs($this->superAdmin())
               ->test(BackupPage::class)
               ->call('runBackup');
   
           /* Assert */
           $component->assertSuccessful()->assertNotified();
       }

   Achievable

   1. Evaluate spatie/laravel-backup as the underlying package rather than hand-rolling archive/dump logic — it already handles DB dump + configurable file disks and is a common Laravel choice; confirm it's acceptable before adding a new dependency.
   2. New ip:backup and ip:restore Artisan commands in Modules/Core/Console/ wrapping the chosen backup mechanism, targeting the uploads disk (used by the existing Upload model) plus the primary DB connection.
   3. New Filament admin page (Modules/Core/Filament/Admin/Pages/) exposing "Run backup now" and "Restore from upload" actions, gated behind a dedicated permission (follow the Permission::MANAGE_SETTINGS-style pattern already used for the Settings page).
   4. If automated nightly backups are in scope (the issue mentions "with automated nightly backups if configured"), add a scheduled command entry and a settings toggle for enabling/disabling it — confirm this is in scope for the first iteration or a follow-up.
   5. Add PHPUnit coverage in Modules/Core/Tests/Feature/.

   Relevant

   Backup/restore is core to disaster recovery and safe migrations between environments; today there is no supported way to do either, meaning any data loss is unrecoverable and any server migration is a manual, unsupported DB/file copy.

   Time-bound

   Sprint 8 (confirm package choice and whether scheduled nightly backups are in scope for this iteration before estimating further).
7. nielsdrost7

   removed a parent issue on Jul 18, 2026

   • [Core]: Epic — Module Core #3
8. nielsdrost7

   added a parent issue on Jul 18, 2026

   • [Epic]: V1→V2 parity — Import, Export, Reports, Dashboard #682