PostgreSQL backup tool with Point-In-Time-Recovery and restore verification
TypeScript backupbackupsdatabasedatabase-backupdevopsdockergolangkubernetesmariadbmongodbmysqlpgpostgrespostgresqls3self-hostedsystem-administrationtoolsweb-ui
FIX (backups): Avoid possibility of breaking DB on backup fail
Rostislav Dugin242d5543d464
diff --git a/backend/internal/features/backups/backups/background_service_test.go b/backend/internal/features/backups/backups/background_service_test.goindex 15c10bd1..060b2109 100644--- a/backend/internal/features/backups/backups/background_service_test.go+++ b/backend/internal/features/backups/backups/background_service_test.go@@ -44,11 +44,8 @@ func Test_MakeBackupForDbHavingBackupDayAgo_BackupCreated(t *testing.T) {// add old backupbackupRepository.Save(&Backup{- Database: database,DatabaseID: database.ID,-- Storage: storage,- StorageID: storage.ID,+ StorageID: storage.ID,Status: BackupStatusCompleted,@@ -105,11 +102,8 @@ func Test_MakeBackupForDbHavingHourAgoBackup_BackupSkipped(t *testing.T) {// add recent backup (1 hour ago)backupRepository.Save(&Backup{- Database: database,DatabaseID: database.ID,-- Storage: storage,- StorageID: storage.ID,+ StorageID: storage.ID,Status: BackupStatusCompleted,@@ -169,11 +163,8 @@ func Test_MakeBackupHavingFailedBackupWithoutRetries_BackupSkipped(t *testing.T)// add failed backupfailMessage := "backup failed"backupRepository.Save(&Backup{- Database: database,DatabaseID: database.ID,-- Storage: storage,- StorageID: storage.ID,+ StorageID: storage.ID,Status: BackupStatusFailed,FailMessage: &failMessage,@@ -234,11 +225,8 @@ func Test_MakeBackupHavingFailedBackupWithRetries_BackupCreated(t *testing.T) {// add failed backupfailMessage := "backup failed"backupRepository.Save(&Backup{- Database: database,DatabaseID: database.ID,-- Storage: storage,- StorageID: storage.ID,+ StorageID: storage.ID,Status: BackupStatusFailed,FailMessage: &failMessage,@@ -262,7 +250,7 @@ func Test_MakeBackupHavingFailedBackupWithRetries_BackupCreated(t *testing.T) {}databases.RemoveTestDatabase(database)- time.Sleep(50 * time.Millisecond) // Wait for cascading deletes+ time.Sleep(100 * time.Millisecond) // Wait for cascading deletesnotifiers.RemoveTestNotifier(notifier)storages.RemoveTestStorage(storage.ID)workspaces_testing.RemoveTestWorkspace(workspace, router)@@ -300,11 +288,8 @@ func Test_MakeBackupHavingFailedBackupWithRetries_RetriesCountNotExceeded(t *tesfor i := 0; i < 3; i++ {backupRepository.Save(&Backup{- Database: database,DatabaseID: database.ID,-- Storage: storage,- StorageID: storage.ID,+ StorageID: storage.ID,Status: BackupStatusFailed,FailMessage: &failMessage,diff --git a/backend/internal/features/backups/backups/controller_test.go b/backend/internal/features/backups/backups/controller_test.goindex ee76c77e..db49b297 100644--- a/backend/internal/features/backups/backups/controller_test.go+++ b/backend/internal/features/backups/backups/controller_test.go@@ -512,9 +512,7 @@ func Test_CancelBackup_InProgressBackup_SuccessfullyCancelled(t *testing.T) {backup := &Backup{ID: uuid.New(),DatabaseID: database.ID,- Database: database,StorageID: storage.ID,- Storage: storage,Status: BackupStatusInProgress,BackupSizeMb: 0,BackupDurationMs: 0,@@ -686,9 +684,7 @@ func createTestBackup(backup := &Backup{ID: uuid.New(),DatabaseID: database.ID,- Database: database,StorageID: storages[0].ID,- Storage: storages[0],Status: BackupStatusCompleted,BackupSizeMb: 10.5,BackupDurationMs: 1000,diff --git a/backend/internal/features/backups/backups/model.go b/backend/internal/features/backups/backups/model.goindex 40c61f96..b7e68e28 100644--- a/backend/internal/features/backups/backups/model.go+++ b/backend/internal/features/backups/backups/model.go@@ -1,8 +1,6 @@package backupsimport (- "postgresus-backend/internal/features/databases"- "postgresus-backend/internal/features/storages""time""github.com/google/uuid"@@ -11,11 +9,8 @@ import (type Backup struct {ID uuid.UUID `json:"id" gorm:"column:id;type:uuid;primaryKey"`- Database *databases.Database `json:"database" gorm:"foreignKey:DatabaseID"`- DatabaseID uuid.UUID `json:"databaseId" gorm:"column:database_id;type:uuid;not null"`-- Storage *storages.Storage `json:"storage" gorm:"foreignKey:StorageID"`- StorageID uuid.UUID `json:"storageId" gorm:"column:storage_id;type:uuid;not null"`+ DatabaseID uuid.UUID `json:"databaseId" gorm:"column:database_id;type:uuid;not null"`+ StorageID uuid.UUID `json:"storageId" gorm:"column:storage_id;type:uuid;not null"`Status BackupStatus `json:"status" gorm:"column:status;not null"`FailMessage *string `json:"failMessage" gorm:"column:fail_message"`diff --git a/backend/internal/features/backups/backups/repository.go b/backend/internal/features/backups/backups/repository.goindex a9e44fd0..0990c0bf 100644--- a/backend/internal/features/backups/backups/repository.go+++ b/backend/internal/features/backups/backups/repository.go@@ -13,18 +13,20 @@ import (type BackupRepository struct{}func (r *BackupRepository) Save(backup *Backup) error {+ if backup.DatabaseID == uuid.Nil || backup.StorageID == uuid.Nil {+ return errors.New("database ID and storage ID are required")+ }+db := storage.GetDb()isNew := backup.ID == uuid.Nilif isNew {backup.ID = uuid.New()return db.Create(backup).- Omit("Database", "Storage").Error}return db.Save(backup).- Omit("Database", "Storage").Error}@@ -33,8 +35,6 @@ func (r *BackupRepository) FindByDatabaseID(databaseID uuid.UUID) ([]*Backup, erif err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("database_id = ?", databaseID).Order("created_at DESC").Find(&backups).Error; err != nil {@@ -56,8 +56,6 @@ func (r *BackupRepository) FindByDatabaseIDWithLimit(if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("database_id = ?", databaseID).Order("created_at DESC").Limit(limit).@@ -73,8 +71,6 @@ func (r *BackupRepository) FindByStorageID(storageID uuid.UUID) ([]*Backup, erroif err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("storage_id = ?", storageID).Order("created_at DESC").Find(&backups).Error; err != nil {@@ -89,8 +85,6 @@ func (r *BackupRepository) FindLastByDatabaseID(databaseID uuid.UUID) (*Backup,if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("database_id = ?", databaseID).Order("created_at DESC").First(&backup).Error; err != nil {@@ -109,8 +103,6 @@ func (r *BackupRepository) FindByID(id uuid.UUID) (*Backup, error) {if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("id = ?", id).First(&backup).Error; err != nil {return nil, err@@ -124,8 +116,6 @@ func (r *BackupRepository) FindByStatus(status BackupStatus) ([]*Backup, error)if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("status = ?", status).Order("created_at DESC").Find(&backups).Error; err != nil {@@ -143,8 +133,6 @@ func (r *BackupRepository) FindByStorageIdAndStatus(if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("storage_id = ? AND status = ?", storageID, status).Order("created_at DESC").Find(&backups).Error; err != nil {@@ -162,8 +150,6 @@ func (r *BackupRepository) FindByDatabaseIdAndStatus(if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("database_id = ? AND status = ?", databaseID, status).Order("created_at DESC").Find(&backups).Error; err != nil {@@ -185,8 +171,6 @@ func (r *BackupRepository) FindBackupsBeforeDate(if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("database_id = ? AND created_at < ?", databaseID, date).Order("created_at DESC").Find(&backups).Error; err != nil {@@ -204,8 +188,6 @@ func (r *BackupRepository) FindByDatabaseIDWithPagination(if err := storage.GetDb().- Preload("Database").- Preload("Storage").Where("database_id = ?", databaseID).Order("created_at DESC").Limit(limit).diff --git a/backend/internal/features/backups/backups/service.go b/backend/internal/features/backups/backups/service.goindex c5fff6a4..11f0ab27 100644--- a/backend/internal/features/backups/backups/service.go+++ b/backend/internal/features/backups/backups/service.go@@ -149,11 +149,16 @@ func (s *BackupService) DeleteBackup(return err}- if backup.Database.WorkspaceID == nil {+ database, err := s.databaseService.GetDatabaseByID(backup.DatabaseID)+ if err != nil {+ return err+ }++ if database.WorkspaceID == nil {return errors.New("cannot delete backup for database without workspace")}- canManage, err := s.workspaceService.CanUserManageDBs(*backup.Database.WorkspaceID, user)+ canManage, err := s.workspaceService.CanUserManageDBs(*database.WorkspaceID, user)if err != nil {return err}@@ -168,11 +173,11 @@ func (s *BackupService) DeleteBackup(s.auditLogService.WriteAuditLog(fmt.Sprintf("Backup deleted for database: %s (ID: %s)",- backup.Database.Name,+ database.Name,backupID.String(),),&user.ID,- backup.Database.WorkspaceID,+ database.WorkspaceID,)return s.deleteBackup(backup)@@ -220,10 +225,7 @@ func (s *BackupService) MakeBackup(databaseID uuid.UUID, isLastTry bool) {backup := &Backup{DatabaseID: databaseID,- Database: database,-- StorageID: storage.ID,- Storage: storage,+ StorageID: storage.ID,Status: BackupStatusInProgress,@@ -427,11 +429,16 @@ func (s *BackupService) CancelBackup(return err}- if backup.Database.WorkspaceID == nil {+ database, err := s.databaseService.GetDatabaseByID(backup.DatabaseID)+ if err != nil {+ return err+ }++ if database.WorkspaceID == nil {return errors.New("cannot cancel backup for database without workspace")}- canManage, err := s.workspaceService.CanUserManageDBs(*backup.Database.WorkspaceID, user)+ canManage, err := s.workspaceService.CanUserManageDBs(*database.WorkspaceID, user)if err != nil {return err}@@ -450,11 +457,11 @@ func (s *BackupService) CancelBackup(s.auditLogService.WriteAuditLog(fmt.Sprintf("Backup cancelled for database: %s (ID: %s)",- backup.Database.Name,+ database.Name,backupID.String(),),&user.ID,- backup.Database.WorkspaceID,+ database.WorkspaceID,)return nil@@ -469,12 +476,17 @@ func (s *BackupService) GetBackupFile(return nil, err}- if backup.Database.WorkspaceID == nil {+ database, err := s.databaseService.GetDatabaseByID(backup.DatabaseID)+ if err != nil {+ return nil, err+ }++ if database.WorkspaceID == nil {return nil, errors.New("cannot download backup for database without workspace")}canAccess, _, err := s.workspaceService.CanUserAccessWorkspace(- *backup.Database.WorkspaceID,+ *database.WorkspaceID,user,)if err != nil {@@ -492,11 +504,11 @@ func (s *BackupService) GetBackupFile(s.auditLogService.WriteAuditLog(fmt.Sprintf("Backup file downloaded for database: %s (ID: %s)",- backup.Database.Name,+ database.Name,backupID.String(),),&user.ID,- backup.Database.WorkspaceID,+ database.WorkspaceID,)return storage.GetFile(backup.ID)diff --git a/backend/internal/features/notifiers/di.go b/backend/internal/features/notifiers/di.goindex ab7bb112..65f3a6c0 100644--- a/backend/internal/features/notifiers/di.go+++ b/backend/internal/features/notifiers/di.go@@ -26,6 +26,9 @@ func GetNotifierService() *NotifierService {return notifierService}+func GetNotifierRepository() *NotifierRepository {+ return notifierRepository+}func SetupDependencies() {workspaces_services.GetWorkspaceService().AddWorkspaceDeletionListener(notifierService)}diff --git a/backend/internal/features/notifiers/repository.go b/backend/internal/features/notifiers/repository.goindex c0559099..fbd51dbb 100644--- a/backend/internal/features/notifiers/repository.go+++ b/backend/internal/features/notifiers/repository.go@@ -165,7 +165,6 @@ func (r *NotifierRepository) FindByWorkspaceID(workspaceID uuid.UUID) ([]*Notififunc (r *NotifierRepository) Delete(notifier *Notifier) error {return storage.GetDb().Transaction(func(tx *gorm.DB) error {-switch notifier.NotifierType {case NotifierTypeTelegram:if notifier.TelegramNotifier != nil {diff --git a/backend/internal/features/restores/controller_test.go b/backend/internal/features/restores/controller_test.goindex d758a2ae..b95d92dc 100644--- a/backend/internal/features/restores/controller_test.go+++ b/backend/internal/features/restores/controller_test.go@@ -323,9 +323,7 @@ func createTestBackup(backup := &backups.Backup{ID: uuid.New(),DatabaseID: database.ID,- Database: database,StorageID: storages[0].ID,- Storage: storages[0],Status: backups.BackupStatusCompleted,BackupSizeMb: 10.5,BackupDurationMs: 1000,diff --git a/backend/internal/features/restores/repository.go b/backend/internal/features/restores/repository.goindex c2fde3a5..edc157ca 100644--- a/backend/internal/features/restores/repository.go+++ b/backend/internal/features/restores/repository.go@@ -62,8 +62,6 @@ func (r *RestoreRepository) FindByStatus(status enums.RestoreStatus) ([]*models.if err := storage.GetDb().- Preload("Backup.Storage").- Preload("Backup.Database").Preload("Backup").Preload("Postgresql").Where("status = ?", status).diff --git a/backend/internal/features/restores/service.go b/backend/internal/features/restores/service.goindex 755e4bee..52831d2b 100644--- a/backend/internal/features/restores/service.go+++ b/backend/internal/features/restores/service.go@@ -62,12 +62,17 @@ func (s *RestoreService) GetRestores(return nil, err}- if backup.Database.WorkspaceID == nil {+ database, err := s.databaseService.GetDatabaseByID(backup.DatabaseID)+ if err != nil {+ return nil, err+ }++ if database.WorkspaceID == nil {return nil, errors.New("cannot get restores for database without workspace")}canAccess, _, err := s.workspaceService.CanUserAccessWorkspace(- *backup.Database.WorkspaceID,+ *database.WorkspaceID,user,)if err != nil {@@ -90,12 +95,17 @@ func (s *RestoreService) RestoreBackupWithAuth(return err}- if backup.Database.WorkspaceID == nil {+ database, err := s.databaseService.GetDatabaseByID(backup.DatabaseID)+ if err != nil {+ return err+ }++ if database.WorkspaceID == nil {return errors.New("cannot restore backup for database without workspace")}canAccess, _, err := s.workspaceService.CanUserAccessWorkspace(- *backup.Database.WorkspaceID,+ *database.WorkspaceID,user,)if err != nil {@@ -135,10 +145,10 @@ func (s *RestoreService) RestoreBackupWithAuth(fmt.Sprintf("Database restored from backup %s for database: %s",backupID.String(),- backup.Database.Name,+ database.Name,),&user.ID,- backup.Database.WorkspaceID,+ database.WorkspaceID,)return nil@@ -152,7 +162,12 @@ func (s *RestoreService) RestoreBackup(return errors.New("backup is not completed")}- if backup.Database.Type == databases.DatabaseTypePostgres {+ database, err := s.databaseService.GetDatabaseByID(backup.DatabaseID)+ if err != nil {+ return err+ }++ if database.Type == databases.DatabaseTypePostgres {if requestDTO.PostgresqlDatabase == nil {return errors.New("postgresql database is required")}@@ -193,7 +208,7 @@ func (s *RestoreService) RestoreBackup(}backupConfig, err := s.backupConfigService.GetBackupConfigByDbId(- backup.Database.ID,+ database.ID,)if err != nil {return err@@ -204,6 +219,7 @@ func (s *RestoreService) RestoreBackup(err = s.restoreBackupUsecase.Execute(backupConfig,restore,+ database,backup,storage,)diff --git a/backend/internal/features/restores/usecases/postgresql/restore_backup_uc.go b/backend/internal/features/restores/usecases/postgresql/restore_backup_uc.goindex b8942ca1..8a5fdeb8 100644--- a/backend/internal/features/restores/usecases/postgresql/restore_backup_uc.go+++ b/backend/internal/features/restores/usecases/postgresql/restore_backup_uc.go@@ -31,12 +31,13 @@ type RestorePostgresqlBackupUsecase struct {}func (uc *RestorePostgresqlBackupUsecase) Execute(+ database *databases.Database,backupConfig *backups_config.BackupConfig,restore models.Restore,backup *backups.Backup,storage *storages.Storage,) error {- if backup.Database.Type != databases.DatabaseTypePostgres {+ if database.Type != databases.DatabaseTypePostgres {return errors.New("database type not supported")}@@ -76,6 +77,7 @@ func (uc *RestorePostgresqlBackupUsecase) Execute(}return uc.restoreFromStorage(+ database,tools.GetPostgresqlExecutable(pg.Version,"pg_restore",@@ -92,6 +94,7 @@ func (uc *RestorePostgresqlBackupUsecase) Execute(// restoreFromStorage restores backup data from storage using pg_restorefunc (uc *RestorePostgresqlBackupUsecase) restoreFromStorage(+ database *databases.Database,pgBin string,args []string,password string,@@ -164,7 +167,7 @@ func (uc *RestorePostgresqlBackupUsecase) restoreFromStorage(// Add the temporary backup file as the last argument to pg_restoreargs = append(args, tempBackupFile)- return uc.executePgRestore(ctx, pgBin, args, pgpassFile, pgConfig, backup)+ return uc.executePgRestore(ctx, database, pgBin, args, pgpassFile, pgConfig)}// downloadBackupToTempFile downloads backup data from storage to a temporary file@@ -240,11 +243,11 @@ func (uc *RestorePostgresqlBackupUsecase) downloadBackupToTempFile(// executePgRestore executes the pg_restore command with proper environment setupfunc (uc *RestorePostgresqlBackupUsecase) executePgRestore(ctx context.Context,+ database *databases.Database,pgBin string,args []string,pgpassFile string,pgConfig *pgtypes.PostgresqlDatabase,- backup *backups.Backup,) error {cmd := exec.CommandContext(ctx, pgBin, args...)uc.logger.Info("Executing PostgreSQL restore command", "command", cmd.String())@@ -293,7 +296,7 @@ func (uc *RestorePostgresqlBackupUsecase) executePgRestore(return fmt.Errorf("restore cancelled due to shutdown")}- return uc.handlePgRestoreError(waitErr, stderrOutput, pgBin, args, backup, pgConfig)+ return uc.handlePgRestoreError(database, waitErr, stderrOutput, pgBin, args, pgConfig)}return nil@@ -341,11 +344,11 @@ func (uc *RestorePostgresqlBackupUsecase) setupPgRestoreEnvironment(// handlePgRestoreError processes and formats pg_restore errorsfunc (uc *RestorePostgresqlBackupUsecase) handlePgRestoreError(+ database *databases.Database,waitErr error,stderrOutput []byte,pgBin string,args []string,- backup *backups.Backup,pgConfig *pgtypes.PostgresqlDatabase,) error {// Enhanced error handling for PostgreSQL connection and restore issues@@ -416,8 +419,8 @@ func (uc *RestorePostgresqlBackupUsecase) handlePgRestoreError()} else if containsIgnoreCase(stderrStr, "database") && containsIgnoreCase(stderrStr, "does not exist") {backupDbName := "unknown"- if backup.Database != nil && backup.Database.Postgresql != nil && backup.Database.Postgresql.Database != nil {- backupDbName = *backup.Database.Postgresql.Database+ if database.Postgresql != nil && database.Postgresql.Database != nil {+ backupDbName = *database.Postgresql.Database}targetDbName := "unknown"diff --git a/backend/internal/features/restores/usecases/restore_backup_uc.go b/backend/internal/features/restores/usecases/restore_backup_uc.goindex b9408788..6c79951c 100644--- a/backend/internal/features/restores/usecases/restore_backup_uc.go+++ b/backend/internal/features/restores/usecases/restore_backup_uc.go@@ -17,11 +17,13 @@ type RestoreBackupUsecase struct {func (uc *RestoreBackupUsecase) Execute(backupConfig *backups_config.BackupConfig,restore models.Restore,+ database *databases.Database,backup *backups.Backup,storage *storages.Storage,) error {- if restore.Backup.Database.Type == databases.DatabaseTypePostgres {+ if database.Type == databases.DatabaseTypePostgres {return uc.restorePostgresqlBackupUsecase.Execute(+ database,backupConfig,restore,backup,diff --git a/backend/internal/features/tests/postgresql_backup_restore_test.go b/backend/internal/features/tests/postgresql_backup_restore_test.goindex 37580a1b..cf624b95 100644--- a/backend/internal/features/tests/postgresql_backup_restore_test.go+++ b/backend/internal/features/tests/postgresql_backup_restore_test.go@@ -171,8 +171,6 @@ func testBackupRestoreForVersion(t *testing.T, pgVersion string, port string) {StorageID: storage.ID,Status: backups.BackupStatusCompleted,CreatedAt: time.Now().UTC(),- Storage: storage,- Database: backupDb,}restoreID := uuid.New()@@ -192,7 +190,7 @@ func testBackupRestoreForVersion(t *testing.T, pgVersion string, port string) {// Restore the backuprestoreBackupUC := usecases_postgresql_restore.GetRestorePostgresqlBackupUsecase()- err = restoreBackupUC.Execute(backupConfig, restore, completedBackup, storage)+ err = restoreBackupUC.Execute(backupDb, backupConfig, restore, completedBackup, storage)assert.NoError(t, err)// Verify restored table existsdiff --git a/frontend/src/features/databases/ui/DatabaseConfigComponent.tsx b/frontend/src/features/databases/ui/DatabaseConfigComponent.tsxindex 68d89006..a9af1cba 100644--- a/frontend/src/features/databases/ui/DatabaseConfigComponent.tsx+++ b/frontend/src/features/databases/ui/DatabaseConfigComponent.tsx@@ -210,7 +210,7 @@ export const DatabaseConfigComponent = ({Last backup error</div>- <div className="mt-3 text-sm">+ <div className="mt-3 text-sm break-words whitespace-pre-wrap">The error:<br />{database.lastBackupErrorMessage}diff --git a/frontend/src/features/notifiers/ui/NotifierComponent.tsx b/frontend/src/features/notifiers/ui/NotifierComponent.tsxindex ae2dc863..adff907f 100644--- a/frontend/src/features/notifiers/ui/NotifierComponent.tsx+++ b/frontend/src/features/notifiers/ui/NotifierComponent.tsx@@ -198,7 +198,7 @@ export const NotifierComponent = ({{notifier.lastSendError}</div>- <div className="mt-3 text-sm text-gray-500">+ <div className="mt-3 text-sm break-words whitespace-pre-wrap text-gray-500">To clean this error (choose any):<ul><li>diff --git a/frontend/src/features/storages/ui/StorageComponent.tsx b/frontend/src/features/storages/ui/StorageComponent.tsxindex b3b6c727..8532704a 100644--- a/frontend/src/features/storages/ui/StorageComponent.tsx+++ b/frontend/src/features/storages/ui/StorageComponent.tsx@@ -196,7 +196,7 @@ export const StorageComponent = ({{storage.lastSaveError}</div>- <div className="mt-3 text-sm text-gray-500">+ <div className="mt-3 text-sm break-words whitespace-pre-wrap text-gray-500">To clean this error (choose any):<ul><li>- test connection via button below (even if you updated settings);</li>