Skip to content

Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.

fix(settings): stop runtime-config migration from resetting user settings on restart

Alexander Sysoevc951561d2a84
diff --git a/server/plugins/2.settings-manager.ts b/server/plugins/2.settings-manager.ts
index 4b94a2c9..0621b61e 100644
--- a/server/plugins/2.settings-manager.ts
+++ b/server/plugins/2.settings-manager.ts
@@ -1,4 +1,6 @@
+import type { SettingValue } from '~~/shared/types/settings'
import { DEFAULT_SETTINGS } from '../services/settings/contants'
+import type { SettingNamespace } from '../services/settings/contants'
import { settingsManager } from '../services/settings/settingsManager'
import { and, eq, tables, useDB } from '../utils/db'
@@ -28,7 +30,12 @@ export default defineNitroPlugin(async (_nitroApp) => {
})
/**
- * Migrate existing configurations from runtimeConfig to the settings system
+ * Migrate existing configurations from runtimeConfig to the settings system.
+ *
+ * Runtime config (env vars / nuxt.config defaults) is only used to seed
+ * settings that the user has never customized. Once a value has been changed
+ * in the dashboard or the setup wizard, it must survive restarts, so settings
+ * that already differ from their default are left untouched.
*/
async function migrateRuntimeConfigToSettings() {
const config = useRuntimeConfig() as any
@@ -47,12 +54,7 @@ async function migrateRuntimeConfigToSettings() {
for (const [key, value] of Object.entries(appSettings)) {
if (value) {
- try {
- await settingsManager.set('app', key as any, value, undefined, true)
- _logger.debug(`Migrated app.${key}`)
- } catch (error) {
- _logger.warn(`Failed to migrate app.${key}:`, error)
- }
+ await migrateSetting('app', key, value, _logger)
}
}
}
@@ -70,12 +72,7 @@ async function migrateRuntimeConfigToSettings() {
for (const [key, value] of Object.entries(mapSettings)) {
if (value) {
- try {
- await settingsManager.set('map', key as any, value, undefined, true)
- _logger.debug(`Migrated map.${key}`)
- } catch (error) {
- _logger.warn(`Failed to migrate map.${key}:`, error)
- }
+ await migrateSetting('map', key, value, _logger)
}
}
}
@@ -83,18 +80,7 @@ async function migrateRuntimeConfigToSettings() {
// Migrate auth settings (GitHub OAuth)
const githubOauthConfig = config.oauth?.github || {}
if (config.public?.oauth?.github?.enabled === true) {
- try {
- await settingsManager.set(
- 'system',
- 'auth.github.enabled' as any,
- true,
- undefined,
- true,
- )
- _logger.debug('Migrated system.auth.github.enabled=true')
- } catch (error) {
- _logger.warn('Failed to migrate system.auth.github.enabled:', error)
- }
+ await migrateSetting('system', 'auth.github.enabled', true, _logger)
}
const githubOauthSettings = {
@@ -104,12 +90,7 @@ async function migrateRuntimeConfigToSettings() {
for (const [key, value] of Object.entries(githubOauthSettings)) {
if (typeof value === 'string' && value.length > 0) {
- try {
- await settingsManager.set('system', key as any, value, undefined, true)
- _logger.debug(`Migrated system.${key}`)
- } catch (error) {
- _logger.warn(`Failed to migrate system.${key}:`, error)
- }
+ await migrateSetting('system', key, value, _logger)
}
}
@@ -178,6 +159,33 @@ async function migrateRuntimeConfigToSettings() {
}
}
+/**
+ * Write a runtime-config value into a setting, but only if the setting still
+ * holds its default value. This keeps the migration one-shot per setting and
+ * prevents nuxt.config defaults (e.g. app.title = "ChronoFrame") from
+ * overwriting user changes on every server start.
+ */
+async function migrateSetting(
+ namespace: SettingNamespace,
+ key: string,
+ value: SettingValue,
+ _logger: ReturnType<typeof logger.dynamic>,
+) {
+ if (!settingsManager.isDefault(namespace, key as any)) {
+ _logger.debug(
+ `Skipping migration of ${namespace}.${key}: already customized by user`,
+ )
+ return
+ }
+
+ try {
+ await settingsManager.set(namespace, key as any, value, undefined, true)
+ _logger.debug(`Migrated ${namespace}.${key}`)
+ } catch (error) {
+ _logger.warn(`Failed to migrate ${namespace}.${key}:`, error)
+ }
+}
+
async function syncGithubOAuthEnvFromSettings() {
const config = useRuntimeConfig() as any
diff --git a/server/services/settings/settingsManager.ts b/server/services/settings/settingsManager.ts
index e0e19f2c..67eb2bdd 100644
--- a/server/services/settings/settingsManager.ts
+++ b/server/services/settings/settingsManager.ts
@@ -209,6 +209,36 @@ export class SettingsManager {
return value as T
}
+ /**
+ * Check whether a setting still holds its default value, i.e. it has never
+ * been customized by the user (via the dashboard, the wizard, or a previous
+ * runtime-config migration with a non-default value).
+ * @returns true if the stored value equals the stored default value.
+ * Also true if the setting does not exist.
+ */
+ isDefault(
+ namespace: SettingNamespace,
+ key: SettingKey<typeof namespace>,
+ ): boolean {
+ const db = useDB()
+ const setting = db
+ .select({
+ value: tables.settings.value,
+ defaultValue: tables.settings.defaultValue,
+ })
+ .from(tables.settings)
+ .where(
+ and(
+ eq(tables.settings.namespace, namespace),
+ eq(tables.settings.key, key),
+ ),
+ )
+ .get()
+
+ if (!setting) return true
+ return setting.value === setting.defaultValue
+ }
+
async set(
namespace: SettingNamespace,
key: SettingKey<typeof namespace>,