Skip to content

Modern Docker Management, Designed for Everyone

refactor: cleanup unused setting key/values on startup (#1519)

Kyle Mendelld2906ae6d1fb
diff --git a/backend/internal/bootstrap/bootstrap.go b/backend/internal/bootstrap/bootstrap.go
index 730248506..b3131df87 100644
--- a/backend/internal/bootstrap/bootstrap.go
+++ b/backend/internal/bootstrap/bootstrap.go
@@ -81,6 +81,7 @@ func Bootstrap(ctx context.Context) error {
appServices.User.CreateDefaultAdmin,
appServices.Settings.MigrateOidcConfigToFields,
appServices.Notification.MigrateDiscordWebhookUrlToFields)
+ utils.CleanupUnknownSettings(appCtx, appServices.Settings)
// Handle agent auto-pairing with API key
if cfg.AgentMode && cfg.AgentToken != "" && cfg.ManagerApiUrl != "" {
diff --git a/backend/internal/database/database.go b/backend/internal/database/database.go
index 001c677cd..b7c7f00ef 100644
--- a/backend/internal/database/database.go
+++ b/backend/internal/database/database.go
@@ -159,7 +159,12 @@ func migrateDatabase(driver database.Driver, dbProvider string) error {
}
if errors.Is(err, migrate.ErrNoChange) {
- slog.Info("Database schema is up to date")
+ version, dirty, versionErr := m.Version()
+ if versionErr != nil {
+ slog.Info("Database schema is up to date")
+ } else {
+ slog.Info("Database schema is up to date", "migrationVersion", version, "dirty", dirty)
+ }
} else {
slog.Info("Database migrations completed successfully")
}
diff --git a/backend/internal/services/settings_service.go b/backend/internal/services/settings_service.go
index 30df942f2..2c9319e5d 100644
--- a/backend/internal/services/settings_service.go
+++ b/backend/internal/services/settings_service.go
@@ -625,6 +625,29 @@ func (s *SettingsService) EnsureDefaultSettings(ctx context.Context) error {
return nil
}
+func (s *SettingsService) PruneUnknownSettings(ctx context.Context) error {
+ allowedKeys := allowedSettingKeys()
+ if len(allowedKeys) == 0 {
+ return nil
+ }
+
+ keys := make([]string, 0, len(allowedKeys))
+ for key := range allowedKeys {
+ keys = append(keys, key)
+ }
+
+ result := s.db.WithContext(ctx).Where("key NOT IN ?", keys).Delete(&models.SettingVariable{})
+ if result.Error != nil {
+ return fmt.Errorf("failed to prune unknown settings: %w", result.Error)
+ }
+
+ if result.RowsAffected > 0 {
+ slog.InfoContext(ctx, "Pruned unknown settings", "count", result.RowsAffected)
+ }
+
+ return nil
+}
+
func (s *SettingsService) PersistEnvSettingsIfMissing(ctx context.Context) error {
rt := reflect.TypeOf(models.Settings{})
appCfg := config.Load()
@@ -646,6 +669,23 @@ func (s *SettingsService) PersistEnvSettingsIfMissing(ctx context.Context) error
return s.LoadDatabaseSettings(ctx)
}
+func allowedSettingKeys() map[string]struct{} {
+ allowed := make(map[string]struct{})
+
+ settingsType := reflect.TypeOf(models.Settings{})
+ for i := 0; i < settingsType.NumField(); i++ {
+ key, _, _ := strings.Cut(settingsType.Field(i).Tag.Get("key"), ",")
+ if key == "" {
+ continue
+ }
+ allowed[key] = struct{}{}
+ }
+
+ allowed["encryptionKey"] = struct{}{}
+
+ return allowed
+}
+
func (s *SettingsService) processEnvField(ctx context.Context, tx *gorm.DB, field reflect.StructField, isEnvOnlyMode bool) error {
tag := field.Tag.Get("key")
key, attrs, _ := strings.Cut(tag, ",")
diff --git a/backend/internal/services/settings_service_test.go b/backend/internal/services/settings_service_test.go
index a2def9476..8c87339b1 100644
--- a/backend/internal/services/settings_service_test.go
+++ b/backend/internal/services/settings_service_test.go
@@ -63,6 +63,31 @@ func TestSettingsService_GetSettings_UnknownKeysIgnored(t *testing.T) {
require.NoError(t, err)
}
+func TestSettingsService_PruneUnknownSettings_RemovesStaleKeys(t *testing.T) {
+ ctx := context.Background()
+ db := setupSettingsTestDB(t)
+ svc, err := NewSettingsService(ctx, db)
+ require.NoError(t, err)
+
+ require.NoError(t, svc.UpdateSetting(ctx, "projectsDirectory", "/tmp/projects"))
+ require.NoError(t, svc.UpdateSetting(ctx, "encryptionKey", "test-encryption-key"))
+ require.NoError(t, svc.UpdateSetting(ctx, "unknownKey", "value"))
+
+ require.NoError(t, svc.PruneUnknownSettings(ctx))
+
+ var sv models.SettingVariable
+ err = svc.db.WithContext(ctx).Where("key = ?", "unknownKey").First(&sv).Error
+ require.ErrorIs(t, err, gorm.ErrRecordNotFound)
+
+ var sv2 models.SettingVariable
+ err = svc.db.WithContext(ctx).Where("key = ?", "projectsDirectory").First(&sv2).Error
+ require.NoError(t, err)
+
+ var sv3 models.SettingVariable
+ err = svc.db.WithContext(ctx).Where("key = ?", "encryptionKey").First(&sv3).Error
+ require.NoError(t, err)
+}
+
func TestSettingsService_GetSettings_EnvOverride_OidcMergeAccounts(t *testing.T) {
ctx := context.Background()
db := setupSettingsTestDB(t)
diff --git a/backend/internal/utils/bootstrap_util.go b/backend/internal/utils/bootstrap_util.go
index 78f839be1..753191bc3 100644
--- a/backend/internal/utils/bootstrap_util.go
+++ b/backend/internal/utils/bootstrap_util.go
@@ -33,6 +33,10 @@ type SettingsManager interface {
EnsureDefaultSettings(ctx context.Context) error
}
+type SettingsPruner interface {
+ PruneUnknownSettings(ctx context.Context) error
+}
+
func InitializeDefaultSettings(ctx context.Context, cfg *config.Config, settingsMgr SettingsManager) {
slog.InfoContext(ctx, "Ensuring default settings are initialized")
@@ -49,6 +53,12 @@ func InitializeDefaultSettings(ctx context.Context, cfg *config.Config, settings
}
}
+func CleanupUnknownSettings(ctx context.Context, settingsMgr SettingsPruner) {
+ if err := settingsMgr.PruneUnknownSettings(ctx); err != nil {
+ slog.ErrorContext(ctx, "Failed to prune unknown settings", "error", err.Error())
+ }
+}
+
func TestDockerConnection(ctx context.Context, testFunc func(context.Context) error) {
if err := testFunc(ctx); err != nil {
slog.WarnContext(ctx, "Docker connection failed during init, local Docker features may be unavailable", "error", err.Error())