FEATURE (backups): Move backups to separate backup config and make feature optional

Author: RostislavDugin

README.md

@@ -2,7 +2,7 @@
   <img src="assets/logo.svg" alt="Postgresus Logo" width="250"/>
 
   <h3>PostgreSQL monitoring and backup</h3>
-  <p>Free, open source and self-hosted solution for automated PostgreSQL monitoring and backups with multiple storage options and notifications</p>
+  <p>Free, open source and self-hosted solution for automated PostgreSQL monitoring and backups. With multiple storage options and notifications</p>
 
   <p>
     <a href="#-features">Features</a> •

assets/healthchecks.svg

@@ -15,7 +15,7 @@ GOOSE_MIGRATION_DIR=./migrations
 # to get Google Drive env variables: add storage in UI and copy data from added storage here 
 TEST_GOOGLE_DRIVE_CLIENT_ID=
 TEST_GOOGLE_DRIVE_CLIENT_SECRET=
-TEST_GOOGLE_DRIVE_TOKEN_JSON=
+TEST_GOOGLE_DRIVE_TOKEN_JSON="{\"access_token\":\"ya29..."
 # testing DBs
 TEST_POSTGRES_13_PORT=5001
 TEST_POSTGRES_14_PORT=5002

backend/.env.development.example

@@ -10,4 +10,5 @@ swagger/docs.go
 swagger/swagger.json
 swagger/swagger.yaml
 postgresus-backend.exe
-ui/build/*
+ui/build/*
+pgdata-for-restore/

backend/.gitignore

@@ -14,7 +14,8 @@ import (
 
 	"postgresus-backend/internal/config"
 	"postgresus-backend/internal/downdetect"
-	"postgresus-backend/internal/features/backups"
+	"postgresus-backend/internal/features/backups/backups"
+	backups_config "postgresus-backend/internal/features/backups/config"
 	"postgresus-backend/internal/features/databases"
 	"postgresus-backend/internal/features/disk"
 	healthcheck_attempt "postgresus-backend/internal/features/healthcheck/attempt"
@@ -135,6 +136,7 @@ func setUpRoutes(r *gin.Engine) {
 	healthcheckConfigController := healthcheck_config.GetHealthcheckConfigController()
 	healthcheckAttemptController := healthcheck_attempt.GetHealthcheckAttemptController()
 	diskController := disk.GetDiskController()
+	backupConfigController := backups_config.GetBackupConfigController()
 
 	downdetectContoller.RegisterRoutes(v1)
 	userController.RegisterRoutes(v1)
@@ -147,10 +149,13 @@ func setUpRoutes(r *gin.Engine) {
 	diskController.RegisterRoutes(v1)
 	healthcheckConfigController.RegisterRoutes(v1)
 	healthcheckAttemptController.RegisterRoutes(v1)
+	backupConfigController.RegisterRoutes(v1)
 }
 
 func setUpDependencies() {
 	backups.SetupDependencies()
+	backups.SetupDependencies()
+	restores.SetupDependencies()
 	healthcheck_config.SetupDependencies()
 }
 

backend/cmd/main.go

@@ -3,16 +3,19 @@ package backups
 import (
 	"log/slog"
 	"postgresus-backend/internal/config"
+	backups_config "postgresus-backend/internal/features/backups/config"
 	"postgresus-backend/internal/features/databases"
 	"postgresus-backend/internal/features/storages"
+	"postgresus-backend/internal/util/period"
 	"time"
 )
 
 type BackupBackgroundService struct {
-	backupService    *BackupService
-	backupRepository *BackupRepository
-	databaseService  *databases.DatabaseService
-	storageService   *storages.StorageService
+	backupService       *BackupService
+	backupRepository    *BackupRepository
+	databaseService     *databases.DatabaseService
+	storageService      *storages.StorageService
+	backupConfigService *backups_config.BackupConfigService
 
 	lastBackupTime time.Time
 	logger         *slog.Logger
@@ -60,15 +63,21 @@ func (s *BackupBackgroundService) failBackupsInProgress() error {
 	}
 
 	for _, backup := range backupsInProgress {
+		backupConfig, err := s.backupConfigService.GetBackupConfigByDbId(backup.DatabaseID)
+		if err != nil {
+			s.logger.Error("Failed to get backup config by database ID", "error", err)
+			continue
+		}
+
 		failMessage := "Backup failed due to application restart"
 		backup.FailMessage = &failMessage
 		backup.Status = BackupStatusFailed
 		backup.BackupSizeMb = 0
 
 		s.backupService.SendBackupNotification(
-			backup.Database,
+			backupConfig,
 			backup,
-			databases.NotificationBackupFailed,
+			backups_config.NotificationBackupFailed,
 			&failMessage,
 		)
 
@@ -87,9 +96,15 @@ func (s *BackupBackgroundService) cleanOldBackups() error {
 	}
 
 	for _, database := range allDatabases {
-		backupStorePeriod := database.StorePeriod
+		backupConfig, err := s.backupConfigService.GetBackupConfigByDbId(database.ID)
+		if err != nil {
+			s.logger.Error("Failed to get backup config by database ID", "error", err)
+			continue
+		}
+
+		backupStorePeriod := backupConfig.StorePeriod
 
-		if backupStorePeriod == databases.PeriodForever {
+		if backupStorePeriod == period.PeriodForever {
 			continue
 		}
 
@@ -148,7 +163,13 @@ func (s *BackupBackgroundService) runPendingBackups() error {
 	}
 
 	for _, database := range allDatabases {
-		if database.BackupInterval == nil {
+		backupConfig, err := s.backupConfigService.GetBackupConfigByDbId(database.ID)
+		if err != nil {
+			s.logger.Error("Failed to get backup config by database ID", "error", err)
+			continue
+		}
+
+		if backupConfig.BackupInterval == nil {
 			continue
 		}
 
@@ -169,13 +190,13 @@ func (s *BackupBackgroundService) runPendingBackups() error {
 			lastBackupTime = &lastBackup.CreatedAt
 		}
 
-		if database.BackupInterval.ShouldTriggerBackup(time.Now().UTC(), lastBackupTime) {
+		if backupConfig.BackupInterval.ShouldTriggerBackup(time.Now().UTC(), lastBackupTime) {
 			s.logger.Info(
 				"Triggering scheduled backup",
 				"databaseId",
 				database.ID,
 				"intervalType",
-				database.BackupInterval.Interval,
+				backupConfig.BackupInterval.Interval,
 			)
 
 			go s.backupService.MakeBackup(database.ID)

…l/features/backups/background_service.go …es/backups/backups/background_service.gobackend/internal/features/backups/background_service.go renamed to backend/internal/features/backups/backups/background_service.go backend/internal/features/backups/background_service.go renamed to backend/internal/features/backups/backups/background_service.go

@@ -1,7 +1,8 @@
 package backups
 
 import (
-	"postgresus-backend/internal/features/backups/usecases"
+	"postgresus-backend/internal/features/backups/backups/usecases"
+	backups_config "postgresus-backend/internal/features/backups/config"
 	"postgresus-backend/internal/features/databases"
 	"postgresus-backend/internal/features/notifiers"
 	"postgresus-backend/internal/features/storages"
@@ -17,15 +18,18 @@ var backupService = &BackupService{
 	backupRepository,
 	notifiers.GetNotifierService(),
 	notifiers.GetNotifierService(),
+	backups_config.GetBackupConfigService(),
 	usecases.GetCreateBackupUsecase(),
 	logger.GetLogger(),
+	[]BackupRemoveListener{},
 }
 
 var backupBackgroundService = &BackupBackgroundService{
 	backupService,
 	backupRepository,
 	databases.GetDatabaseService(),
 	storages.GetStorageService(),
+	backups_config.GetBackupConfigService(),
 	time.Now().UTC(),
 	logger.GetLogger(),
 }
@@ -36,9 +40,11 @@ var backupController = &BackupController{
 }
 
 func SetupDependencies() {
-	databases.
-		GetDatabaseService().
+	backups_config.
+		GetBackupConfigService().
 		SetDatabaseStorageChangeListener(backupService)
+
+	databases.GetDatabaseService().AddDbRemoveListener(backupService)
 }
 
 func GetBackupService() *BackupService {

…/internal/features/backups/controller.go …l/features/backups/backups/controller.gobackend/internal/features/backups/controller.go renamed to backend/internal/features/backups/backups/controller.go backend/internal/features/backups/controller.go renamed to backend/internal/features/backups/backups/controller.go

@@ -6,5 +6,4 @@ const (
 	BackupStatusInProgress BackupStatus = "IN_PROGRESS"
 	BackupStatusCompleted  BackupStatus = "COMPLETED"
 	BackupStatusFailed     BackupStatus = "FAILED"
-	BackupStatusDeleted    BackupStatus = "DELETED"
 )

backend/internal/features/backups/di.go …/internal/features/backups/backups/di.gobackend/internal/features/backups/di.go renamed to backend/internal/features/backups/backups/di.go backend/internal/features/backups/di.go renamed to backend/internal/features/backups/backups/di.go

@@ -1,6 +1,7 @@
 package backups
 
 import (
+	backups_config "postgresus-backend/internal/features/backups/config"
 	"postgresus-backend/internal/features/databases"
 	"postgresus-backend/internal/features/notifiers"
 	"postgresus-backend/internal/features/storages"
@@ -19,10 +20,15 @@ type NotificationSender interface {
 type CreateBackupUsecase interface {
 	Execute(
 		backupID uuid.UUID,
+		backupConfig *backups_config.BackupConfig,
 		database *databases.Database,
 		storage *storages.Storage,
 		backupProgressListener func(
 			completedMBs float64,
 		),
 	) error
 }
+
+type BackupRemoveListener interface {
+	OnBeforeBackupRemove(backup *Backup) error
+}