admin/Suwayomi-Server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix/server startup config update failure handling (#1646)

Browse Source 
* Catch config value migration exception

In case the value did not exist in the config a "ConfigException.Missing" exception was thrown which caused the whole migration to fail.

Fixes #1645

* Improve config migration logging

* Update user config file after config update

The user config file gets reset before the update.
This could cause the user settings to get lost on the next server start in case something went wrong during the update and the updated config never got saved to the actual file.
This commit is contained in:
schroda
2025-09-14 16:32:23 +02:00
committed by GitHub
parent 2818fbe575
commit bbd7e30298
2 changed files with 65 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigManager.kt
+14 -10
View File
@@ -120,14 +120,16 @@ open class ConfigManager {
}
}
fun resetUserConfig(updateInternalConfig: Boolean = true): ConfigDocument {
private fun createConfigDocumentFromReference(): ConfigDocument {
val serverConfigFileContent = this::class.java.getResource("/server-reference.conf")?.readText()
val serverConfigDoc = ConfigDocumentFactory.parseString(serverConfigFileContent)
userConfigFile.writeText(serverConfigDoc.render())
return ConfigDocumentFactory.parseString(serverConfigFileContent)
}
if (updateInternalConfig) {
getUserConfig().entrySet().forEach { internalConfig = internalConfig.withValue(it.key, it.value) }
}
fun resetUserConfig(): ConfigDocument {
val serverConfigDoc = createConfigDocumentFromReference()
userConfigFile.writeText(serverConfigDoc.render())
getUserConfig().entrySet().forEach { internalConfig = internalConfig.withValue(it.key, it.value) }
return serverConfigDoc
}
@@ -135,8 +137,9 @@ open class ConfigManager {
/**
* Makes sure the "UserConfig" is up-to-date.
*
* - adds missing settings
* - removes outdated settings
* - Adds missing settings
* - Migrates deprecated settings
* - Removes outdated settings
*/
fun updateUserConfig(migrate: ConfigDocument.(Config) -> ConfigDocument) {
val serverConfig = ConfigFactory.parseResources("server-reference.conf")
@@ -149,16 +152,17 @@ open class ConfigManager {
}
val hasMissingSettings = refKeys.any { !userConfig.hasPath(it) }
val hasOutdatedSettings = userConfig.entrySet().any { !refKeys.contains(it.key) && it.key.count { c -> c == '.' } <= 1 }
val isUserConfigOutdated = hasMissingSettings || hasOutdatedSettings
if (!isUserConfigOutdated) {
return
}
logger.debug {
"user config is out of date, updating... (missingSettings= $hasMissingSettings, outdatedSettings= $hasOutdatedSettings"
"user config is out of date, updating... (missingSettings= $hasMissingSettings, outdatedSettings= $hasOutdatedSettings)"
}
var newUserConfigDoc: ConfigDocument = resetUserConfig(false)
var newUserConfigDoc: ConfigDocument = createConfigDocumentFromReference()
userConfig
.entrySet()
.filter {