Update backup manager for consistency in variable naming and improved logging format

Author: JacksonTheMaster

src/managers/backupmgr/backupinterface.go

@@ -59,8 +59,8 @@ func RegisterHTTPHandler(handler *HTTPHandler) {
 // GetBackupConfig returns a properly configured BackupConfig
 func GetBackupConfig() BackupConfig {
 
-	uuid := uuid.New()
-	bmIdentifier := "[BM" + uuid.String()[:6] + "]:"
+	id := uuid.New()
+	bmIdentifier := "[BM" + id.String()[:6] + "]:"
 	return BackupConfig{
 		WorldName:     config.GetSaveName(),
 		BackupDir:     config.GetConfiguredBackupDir(),

src/managers/backupmgr/manager.go

@@ -23,7 +23,7 @@ can coexist but may conflict if configured with overlapping directories.
 
 // Initialize checks for BackupDir and waits until it exists, then ensures SafeBackupDir exists.
 // It returns a channel that signals when initialization is complete or an error occurs.
-func (m *BackupManager) Initialize(bmIdentifier string) <-chan error {
+func (m *BackupManager) Initialize(identifier string) <-chan error {
 	m.mu.Lock()
 	defer m.mu.Unlock()
 
@@ -40,38 +40,38 @@ func (m *BackupManager) Initialize(bmIdentifier string) <-chan error {
 			if stat, err := os.Stat(m.config.BackupDir); err == nil {
 				if stat.IsDir() {
 					// Directory exists, proceed
-					logger.Backup.Debugf("%s found backup directory: %s", bmIdentifier, m.config.BackupDir)
+					logger.Backup.Debugf("%s found backup directory: %s", identifier, m.config.BackupDir)
 					break
 				}
-				result <- fmt.Errorf("%s backup path %s is not a directory", bmIdentifier, m.config.BackupDir)
+				result <- fmt.Errorf("%s backup path %s is not a directory", identifier, m.config.BackupDir)
 				return
 			} else if !os.IsNotExist(err) {
 				// An error other than "not exists" occurred
-				result <- fmt.Errorf("%s error checking backup directory %s: %v", bmIdentifier, m.config.BackupDir, err)
+				result <- fmt.Errorf("%s error checking backup directory %s: %v", identifier, m.config.BackupDir, err)
 				return
 			}
 
-			logger.Backup.Debugf("%s waiting for save folder "+m.config.BackupDir+" to be created by Stationeers...", bmIdentifier)
+			logger.Backup.Debugf("%s waiting for save folder "+m.config.BackupDir+" to be created by Stationeers...", identifier)
 			select {
 			case <-m.ctx.Done():
-				result <- fmt.Errorf("%s I have to go, the config was likely changed: %s", bmIdentifier, m.ctx.Err())
+				result <- fmt.Errorf("%s I have to go, the config was likely changed: %s", identifier, m.ctx.Err())
 				return
 			case <-time.After(pollInterval):
 				// Continue polling
 			}
 		}
 
 		if time.Now().After(deadline) {
-			result <- fmt.Errorf("%s timeout waiting for backup directory %s to be created", bmIdentifier, m.config.BackupDir)
+			result <- fmt.Errorf("%s timeout waiting for backup directory %s to be created", identifier, m.config.BackupDir)
 			return
 		}
 
 		// Ensure SafeBackupDir exists, create it if it doesn't
 		if err := os.MkdirAll(m.config.SafeBackupDir, os.ModePerm); err != nil {
-			result <- fmt.Errorf("%s error creating safe backup directory %s: %v", bmIdentifier, m.config.SafeBackupDir, err)
+			result <- fmt.Errorf("%s error creating safe backup directory %s: %v", identifier, m.config.SafeBackupDir, err)
 			return
 		}
-		logger.Backup.Debugf("%s created safebackups at %s", bmIdentifier, m.config.SafeBackupDir)
+		logger.Backup.Debugf("%s created safebackups at %s", identifier, m.config.SafeBackupDir)
 
 		result <- nil
 	}()
@@ -80,24 +80,23 @@ func (m *BackupManager) Initialize(bmIdentifier string) <-chan error {
 }
 
 // Start begins the backup monitoring and cleanup routines
-func (m *BackupManager) Start(Identifier string) error {
+func (m *BackupManager) Start(identifier string) error {
 	// Wait for initialization to complete
-	bmIdentifier := Identifier
 
-	logger.Backup.Debugf("%s is waiting for save folder initialization...", bmIdentifier)
-	initResult := <-m.Initialize(bmIdentifier)
+	logger.Backup.Debugf("%s is waiting for save folder initialization...", identifier)
+	initResult := <-m.Initialize(identifier)
 	if initResult != nil {
-		return fmt.Errorf("%s failed to initialize backup manager : %w", bmIdentifier, initResult)
+		return fmt.Errorf("%s failed to initialize backup manager : %w", identifier, initResult)
 	}
-	logger.Backup.Infof("%s Backup manager instance started", bmIdentifier)
+	logger.Backup.Infof("%s Backup manager instance started", identifier)
 
 	// Start file watcher
-	watcher, err := newFsWatcher(m.config.BackupDir, bmIdentifier)
+	watcher, err := newFsWatcher(m.config.BackupDir, identifier)
 	if err != nil {
 		return fmt.Errorf("failed to create autosave watcher: %w", err)
 	}
 	m.watcher = watcher
-	go m.watchBackups(Identifier)
+	go m.watchBackups(identifier)
 
 	if config.GetIsCleanupEnabled() {
 		go m.startCleanupRoutine()
@@ -107,31 +106,31 @@ func (m *BackupManager) Start(Identifier string) error {
 }
 
 // watchBackups monitors the backup directory for new files
-func (m *BackupManager) watchBackups(Identifier string) {
+func (m *BackupManager) watchBackups(identifier string) {
 	m.wg.Add(1)
 	defer m.wg.Done()
 
-	logger.Backup.Debugf("%s Starting backup file watcher...", Identifier)
-	defer logger.Backup.Debugf("%s Backup file watcher stopped", Identifier)
+	logger.Backup.Debugf("%s Starting backup file watcher...", identifier)
+	defer logger.Backup.Debugf("%s Backup file watcher stopped", identifier)
 
 	for {
 		select {
 		case <-m.ctx.Done():
-			logger.Backup.Debugf("%s WatchBackups stopped due to context cancellation", Identifier)
+			logger.Backup.Debugf("%s WatchBackups stopped due to context cancellation", identifier)
 			return
 		case event, ok := <-m.watcher.events:
 			if !ok {
 				return
 			}
 			if event.Op&fsnotify.Create == fsnotify.Create {
-				logger.Backup.Infof("%s New backup file detected: %s", Identifier, event.Name)
+				logger.Backup.Infof("%s New backup file detected: %s", identifier, event.Name)
 				m.handleNewBackup(event.Name)
 			}
 		case err, ok := <-m.watcher.errors:
 			if !ok {
 				return
 			}
-			logger.Backup.Errorf("%s Backup watcher error: %s", Identifier, err.Error())
+			logger.Backup.Errorf("%s Backup watcher error: %s", identifier, err.Error())
 		}
 	}
 }

src/managers/backupmgr/restore.go

@@ -17,7 +17,7 @@ import (
 func (m *BackupManager) RestoreBackup(index int) error {
 	m.mu.Lock()
 	defer m.mu.Unlock()
-	logger.Backup.Infof("Restoring backup with index %s", fmt.Sprintf("%d", index))
+	logger.Backup.Infof("Restoring backup with index %d", index)
 
 	groups, err := m.getBackupGroups()
 	if err != nil {

src/managers/backupmgr/watcher.go

@@ -19,16 +19,16 @@ type fsWatcher struct {
 }
 
 // newFsWatcher creates a new file system watcher
-func newFsWatcher(path string, Identifier string) (*fsWatcher, error) {
+func newFsWatcher(path string, identifier string) (*fsWatcher, error) {
 	// Normalize path
 	normalizedPath := filepath.Clean(path)
-	logger.Backup.Debugf("%s Creating watcher for path: %s ", Identifier, normalizedPath)
+	logger.Backup.Debugf("%s Creating watcher for path: %s", identifier, normalizedPath)
 
 	watcher, err := fsnotify.NewWatcher()
 	if err != nil {
-		return nil, fmt.Errorf("%s failed to create watcher: %w", Identifier, err)
+		return nil, fmt.Errorf("%s failed to create watcher: %w", identifier, err)
 	}
-	logger.Backup.Debugf("%s Watcher created successfully", Identifier)
+	logger.Backup.Debugf("%s Watcher created successfully", identifier)
 
 	// Watch the root save path and all subdirectories
 	err = filepath.WalkDir(normalizedPath, func(subPath string, d os.DirEntry, err error) error {
@@ -37,16 +37,16 @@ func newFsWatcher(path string, Identifier string) (*fsWatcher, error) {
 		}
 		if d.IsDir() {
 			if err := watcher.Add(subPath); err != nil {
-				logger.Backup.Errorf("%s Failed to add subdir %s to watcher: %s ", Identifier, subPath, err.Error())
+				logger.Backup.Errorf("%s Failed to add subdir %s to watcher: %s", identifier, subPath, err.Error())
 			} else {
-				logger.Backup.Debugf("%s Added subdir %s to watcher", Identifier, subPath)
+				logger.Backup.Debugf("%s Added subdir %s to watcher", identifier, subPath)
 			}
 		}
 		return nil
 	})
 	if err != nil {
 		watcher.Close()
-		return nil, fmt.Errorf("%s failed to add subdirectories to watcher: %w", Identifier, err)
+		return nil, fmt.Errorf("%s failed to add subdirectories to watcher: %w", identifier, err)
 	}
 
 	w := &fsWatcher{