feat(settings): report which saved keys need a restart
Every settings update answered with a bare success, so the console could not tell a change that took effect at once from one written to the file that the running program would keep ignoring until it was restarted — the listener address, the storage paths, the Komari dashboard URL. Classify the patch instead. config.RestartRequiredKeys expands a patch into the dot-separated paths of its leaves and intersects them with the settings main reads before it starts serving, and the settings endpoint returns that list as data.restartRequired. It is a pure function of the patch, so UpdateSettings keeps its signature and nothing else has to change; the write succeeds either way, and the field only says which edits are not live. Matching is by overlap rather than equality, so a patch that names a section — replacing it, or deleting it with a null — reports the startup-only keys inside it, while a sibling subtree like webhook.endpoints is not mistaken for webhook.enabled. The result is never nil, so an update with nothing to report serializes as [] rather than null and a client can iterate it without a guard. The console reads the field in ConfigSection and warns instead of confirming, naming the keys that are pending; Settings.vue's hints for the Komari URL, the listen address and the storage paths now say which of their fields is affected rather than labelling the whole card.
This commit is contained in:
@@ -6,6 +6,7 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"nukumizu-backend/global"
|
||||
@@ -23,6 +24,89 @@ const (
|
||||
// accepted constants above.
|
||||
var ErrUnsupportedSettingsType = errors.New("unsupported settings type")
|
||||
|
||||
// startupOnlySettings are the config.json keys that are read once before the
|
||||
// program starts serving and never again: the listener addresses, the paths the
|
||||
// databases are opened from, and the Komari dashboard its client is built
|
||||
// against. Editing one writes the file and replaces the in-memory
|
||||
// configuration, but the running program keeps the old value, so an update that
|
||||
// touches one is reported back to the caller instead of being silently
|
||||
// accepted.
|
||||
//
|
||||
// Keep this in step with main: these are exactly the settings main reads before
|
||||
// the HTTP server comes up. Everything else — controllerMethod, networkProxy,
|
||||
// the message templates, the debug switches — is picked up at runtime.
|
||||
var startupOnlySettings = []string{
|
||||
"system.listenAddr",
|
||||
"system.listenPort",
|
||||
"webhook.enabled",
|
||||
"webhook.listenAddr",
|
||||
"webhook.listenPort",
|
||||
"komari.dashboardURL",
|
||||
"dataPath",
|
||||
"dbPath",
|
||||
}
|
||||
|
||||
// RestartRequiredKeys lists the settings in patch that only take effect at
|
||||
// startup, as dot-separated paths, in the order startupOnlySettings declares
|
||||
// them. Only config.json carries such settings; an update to one of the other
|
||||
// files always reports nothing.
|
||||
//
|
||||
// The write itself succeeds either way — this is advice for the user, not a
|
||||
// rejection. The result is never nil, so a caller can put it straight into a
|
||||
// JSON response and get [] rather than null.
|
||||
func RestartRequiredKeys(settingsType string, patch map[string]interface{}) []string {
|
||||
keys := []string{}
|
||||
if settingsType != SettingGlobal {
|
||||
return keys
|
||||
}
|
||||
|
||||
patched := patchPaths(patch)
|
||||
for _, watched := range startupOnlySettings {
|
||||
for _, path := range patched {
|
||||
if pathsOverlap(path, watched) {
|
||||
keys = append(keys, watched)
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
return keys
|
||||
}
|
||||
|
||||
// patchPaths expands a nested settings patch into the dot-separated paths of its
|
||||
// leaves. An object is descended into rather than reported, so a patch that only
|
||||
// names sections still resolves to the keys it changes, and a JSON null is a
|
||||
// leaf because it deletes the key it names.
|
||||
func patchPaths(patch map[string]interface{}) []string {
|
||||
paths := []string{}
|
||||
var walk func(prefix string, node map[string]interface{})
|
||||
walk = func(prefix string, node map[string]interface{}) {
|
||||
for key, value := range node {
|
||||
path := key
|
||||
if prefix != "" {
|
||||
path = prefix + "." + key
|
||||
}
|
||||
if nested, ok := value.(map[string]interface{}); ok && nested != nil {
|
||||
walk(path, nested)
|
||||
continue
|
||||
}
|
||||
paths = append(paths, path)
|
||||
}
|
||||
}
|
||||
walk("", patch)
|
||||
return paths
|
||||
}
|
||||
|
||||
// pathsOverlap reports whether a patched path and a watched setting can affect
|
||||
// each other: they are the same key, the patch names something inside the
|
||||
// watched setting, or the patch names a section the watched setting lives in.
|
||||
// The last case matters because a patch may replace a whole section, which
|
||||
// changes every key under it.
|
||||
func pathsOverlap(patched, watched string) bool {
|
||||
return patched == watched ||
|
||||
strings.HasPrefix(patched, watched+".") ||
|
||||
strings.HasPrefix(watched, patched+".")
|
||||
}
|
||||
|
||||
// settingsLock serializes read-modify-write access to the on-disk configuration
|
||||
// files so concurrent admin edits (UpdateSettings) and the node tracker's
|
||||
// background save (SaveBotNodeConfig) cannot lose each other's updates.
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
@@ -148,6 +149,162 @@ func TestUpdateSettingsReplacesArraysAndKeepsNumbers(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestRestartRequiredKeys(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
settingsType string
|
||||
patch map[string]interface{}
|
||||
want []string
|
||||
}{
|
||||
{
|
||||
name: "a runtime switch needs no restart",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"system": map[string]interface{}{"debugMode": true}},
|
||||
want: []string{},
|
||||
},
|
||||
{
|
||||
name: "the listen port does",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"system": map[string]interface{}{"listenPort": "9090"}},
|
||||
want: []string{"system.listenPort"},
|
||||
},
|
||||
{
|
||||
name: "only the startup key of a mixed patch is reported",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{
|
||||
"system": map[string]interface{}{"listenPort": "9090", "debugMode": true},
|
||||
},
|
||||
want: []string{"system.listenPort"},
|
||||
},
|
||||
{
|
||||
name: "a top-level path is reported",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"dataPath": "/srv/data"},
|
||||
want: []string{"dataPath"},
|
||||
},
|
||||
{
|
||||
name: "results follow the declared order, not the patch order",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"dbPath": "/srv/db", "dataPath": "/srv/data"},
|
||||
want: []string{"dataPath", "dbPath"},
|
||||
},
|
||||
{
|
||||
name: "deleting a startup key with null is reported",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"system": map[string]interface{}{"listenPort": nil}},
|
||||
want: []string{"system.listenPort"},
|
||||
},
|
||||
{
|
||||
name: "replacing a whole section reports the startup keys inside it",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"webhook": map[string]interface{}{"listenAddr": "127.0.0.1"}},
|
||||
want: []string{"webhook.listenAddr"},
|
||||
},
|
||||
{
|
||||
// Deleting the section resets the URL to its built-in default.
|
||||
name: "deleting a section the startup key lives in reports it",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"komari": nil},
|
||||
want: []string{"komari.dashboardURL"},
|
||||
},
|
||||
{
|
||||
name: "deleting a section reports every startup key inside it",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"webhook": nil},
|
||||
want: []string{"webhook.enabled", "webhook.listenAddr", "webhook.listenPort"},
|
||||
},
|
||||
{
|
||||
// An empty object merges nothing, so it changes no key and needs no
|
||||
// restart — surprising enough to pin.
|
||||
name: "an empty object changes nothing",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{"komari": map[string]interface{}{}},
|
||||
want: []string{},
|
||||
},
|
||||
{
|
||||
// webhook.endpoints must not be mistaken for webhook.enabled.
|
||||
name: "a sibling subtree is not mistaken for the startup key",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{
|
||||
"webhook": map[string]interface{}{
|
||||
"endpoints": map[string]interface{}{"example": map[string]interface{}{"enabled": true}},
|
||||
},
|
||||
},
|
||||
want: []string{},
|
||||
},
|
||||
{
|
||||
// The Komari credentials are re-read on the next login, so only the
|
||||
// dashboard URL is startup-only.
|
||||
name: "komari credentials are not startup-only",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{
|
||||
"komari": map[string]interface{}{
|
||||
"account": map[string]interface{}{"username": "admin", "password": "x"},
|
||||
},
|
||||
},
|
||||
want: []string{},
|
||||
},
|
||||
{
|
||||
name: "controller settings are not startup-only",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{
|
||||
"controllerMethod": map[string]interface{}{
|
||||
"telegram": map[string]interface{}{"enabled": true, "botToken": "t"},
|
||||
},
|
||||
},
|
||||
want: []string{},
|
||||
},
|
||||
{
|
||||
name: "an empty patch reports nothing",
|
||||
settingsType: SettingGlobal,
|
||||
patch: map[string]interface{}{},
|
||||
want: []string{},
|
||||
},
|
||||
{
|
||||
// Only config.json has settings that are read once at startup.
|
||||
name: "the other settings files never need a restart",
|
||||
settingsType: SettingBotUserConfig,
|
||||
patch: map[string]interface{}{"dataPath": "/srv/data"},
|
||||
want: []string{},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
got := RestartRequiredKeys(tc.settingsType, tc.patch)
|
||||
if !reflect.DeepEqual(got, tc.want) {
|
||||
t.Errorf("RestartRequiredKeys() = %v, want %v", got, tc.want)
|
||||
}
|
||||
if got == nil {
|
||||
t.Error("the result must never be nil, so it serializes as [] rather than null")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestRestartRequiredKeysIsAdvisory pins that reporting a startup-only key does
|
||||
// not stop the write: the caller is told, the file is still updated.
|
||||
func TestRestartRequiredKeysIsAdvisory(t *testing.T) {
|
||||
writeTempConfig(t, &global.ConfigPath.Global, `{"system":{"listenPort":"8080"}}`)
|
||||
|
||||
keys := RestartRequiredKeys(SettingGlobal, map[string]interface{}{
|
||||
"system": map[string]interface{}{"listenPort": "9090"},
|
||||
})
|
||||
if len(keys) != 1 {
|
||||
t.Fatalf("expected the listen port to be reported, got %v", keys)
|
||||
}
|
||||
|
||||
if err := UpdateSettings(SettingGlobal, map[string]interface{}{
|
||||
"system": map[string]interface{}{"listenPort": "9090"},
|
||||
}); err != nil {
|
||||
t.Fatalf("UpdateSettings: %v", err)
|
||||
}
|
||||
|
||||
if got := Current().System.ListenPort; got != "9090" {
|
||||
t.Errorf("the update was not applied: listenPort = %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSettingsTypeValidation(t *testing.T) {
|
||||
for _, valid := range []string{SettingGlobal, SettingBotUserConfig, SettingBotNodeConfig} {
|
||||
if !IsValidSettingsType(valid) {
|
||||
|
||||
Reference in New Issue
Block a user