Skip to content

Open-source AI browser agent for Chrome and Firefox (monorepo) 🧠

companion: handle settings save failures across controls

Barack Sokullub83c891b84e6
diff --git a/webbrain-systray/internal/app/app.go b/webbrain-systray/internal/app/app.go
index fde848155..b1c8168bc 100644
--- a/webbrain-systray/internal/app/app.go
+++ b/webbrain-systray/internal/app/app.go
@@ -504,11 +504,20 @@ func (a *App) SetNetwork(on bool) error {
if err := a.restartOn(s, port, true); err != nil {
if on {
// Could not listen on the network on this port: back to this computer only.
- s, _ = a.Store.Update(func(s *settings.Settings) { s.Network = false })
- _ = a.restartOn(s, port, false)
- a.setNotice(fmt.Sprintf(i18n.T("network_failed"), port))
+ restored, saveErr := a.Store.Update(func(s *settings.Settings) { s.Network = false })
+ restored.Network = false // keep the listener local even if disk is full
+ restartErr := a.restartOn(restored, port, false)
+ if restartErr == nil {
+ a.setNotice(fmt.Sprintf(i18n.T("network_failed"), port))
+ }
+ return errors.Join(err, saveErr, restartErr)
}
- return err
+ // Disabling network access must stay local; a nearby loopback port is
+ // preferable to restoring the externally reachable listener.
+ if fallbackErr := a.restartOn(s, port, false); fallbackErr != nil {
+ return errors.Join(err, fallbackErr)
+ }
+ return nil
}
return nil
}
@@ -529,6 +538,7 @@ func (a *App) SetPort(port int) error {
}
if err := a.restartProxy(s); err != nil {
restored, saveErr := a.Store.Update(func(s *settings.Settings) { s.Port = previous.Port })
+ restored.Port = previous.Port // restore the listener even if disk is full
restorePort := previousPort
if restorePort == 0 {
restorePort = previous.Port
@@ -585,16 +595,22 @@ func (a *App) listeners() int {
}
func (a *App) SetAutostart(on bool) error {
+ previous := osutil.AutostartEnabled()
if err := osutil.SetAutostart(on); err != nil {
return err
}
- _, err := a.Store.Update(func(s *settings.Settings) { s.Autostart = on })
+ if _, err := a.Store.Update(func(s *settings.Settings) { s.Autostart = on }); err != nil {
+ return errors.Join(err, osutil.SetAutostart(previous))
+ }
a.changed()
- return err
+ return nil
}
-func (a *App) SetLanguage(l string) {
- _, _ = a.Store.Update(func(s *settings.Settings) { s.Language = l })
+func (a *App) SetLanguage(l string) error {
+ if _, err := a.Store.Update(func(s *settings.Settings) { s.Language = l }); err != nil {
+ return err
+ }
i18n.Set(l)
a.changed()
+ return nil
}
diff --git a/webbrain-systray/internal/app/guards_test.go b/webbrain-systray/internal/app/guards_test.go
index 9ca60b52f..5c78a9cf4 100644
--- a/webbrain-systray/internal/app/guards_test.go
+++ b/webbrain-systray/internal/app/guards_test.go
@@ -3,10 +3,12 @@ package app
import (
"net/http"
"net/http/httptest"
+ "os"
"testing"
"github.com/gin-gonic/gin"
+ "github.com/esokullu/webbrain-systray/internal/paths"
"github.com/esokullu/webbrain-systray/internal/settings"
)
@@ -25,6 +27,31 @@ func TestLocalHost(t *testing.T) {
}
}
+func TestDecisionControlsRejectFailedSettingsSave(t *testing.T) {
+ gin.SetMode(gin.TestMode)
+ t.Setenv("WBC_HOME", t.TempDir())
+ store, err := settings.Open()
+ if err != nil {
+ t.Fatal(err)
+ }
+ if err := os.Mkdir(paths.Settings()+".tmp", 0o700); err != nil {
+ t.Fatal(err)
+ }
+ a := New("test", store)
+ e := gin.New()
+ a.routes(e)
+ for _, route := range []string{"/companion/api/decision/load", "/companion/api/decision/unload"} {
+ r := httptest.NewRequest(http.MethodPost, "http://127.0.0.1:8327"+route, nil)
+ r.RemoteAddr = "127.0.0.1:50000"
+ r.Header.Set("X-Companion-Key", store.Get().PanelToken)
+ w := httptest.NewRecorder()
+ e.ServeHTTP(w, r)
+ if w.Code != http.StatusInternalServerError || store.Get().Decision.Enabled {
+ t.Fatalf("%s: status %d decision enabled %v, want save error and unchanged state", route, w.Code, store.Get().Decision.Enabled)
+ }
+ }
+}
+
func TestLocalClientAllowed(t *testing.T) {
cases := []struct {
origin, site string
diff --git a/webbrain-systray/internal/app/routes.go b/webbrain-systray/internal/app/routes.go
index 0c9d6b77f..defa5df0e 100644
--- a/webbrain-systray/internal/app/routes.go
+++ b/webbrain-systray/internal/app/routes.go
@@ -439,17 +439,23 @@ func (a *App) routes(e *gin.Engine) {
c.JSON(http.StatusOK, gin.H{"ok": true})
})
api.POST("/decision/load", func(c *gin.Context) {
+ if _, err := a.Store.Update(func(s *settings.Settings) { s.Decision.Enabled = true }); err != nil {
+ fail(c, http.StatusInternalServerError, err)
+ return
+ }
go func() {
if err := a.D1.Load(); err != nil {
logx.Printf("decision load: %v", err)
}
}()
- _, _ = a.Store.Update(func(s *settings.Settings) { s.Decision.Enabled = true })
c.JSON(http.StatusOK, gin.H{"ok": true})
})
api.POST("/decision/unload", func(c *gin.Context) {
+ if _, err := a.Store.Update(func(s *settings.Settings) { s.Decision.Enabled = false }); err != nil {
+ fail(c, http.StatusInternalServerError, err)
+ return
+ }
a.D1.Unload()
- _, _ = a.Store.Update(func(s *settings.Settings) { s.Decision.Enabled = false })
c.JSON(http.StatusOK, gin.H{"ok": true})
})
api.POST("/decision/test", func(c *gin.Context) {
@@ -482,10 +488,16 @@ func (a *App) routes(e *gin.Engine) {
}
}
if req.Language != nil {
- a.SetLanguage(*req.Language)
+ if err := a.SetLanguage(*req.Language); err != nil {
+ fail(c, http.StatusInternalServerError, err)
+ return
+ }
}
if req.Welcomed != nil {
- _, _ = a.Store.Update(func(s *settings.Settings) { s.Welcomed = *req.Welcomed })
+ if _, err := a.Store.Update(func(s *settings.Settings) { s.Welcomed = *req.Welcomed }); err != nil {
+ fail(c, http.StatusInternalServerError, err)
+ return
+ }
}
if req.Port != nil && (*req.Port < 1024 || *req.Port > 65535) {
fail(c, http.StatusBadRequest, errors.New("choose a port between 1024 and 65535"))
diff --git a/webbrain-systray/internal/d1/manager.go b/webbrain-systray/internal/d1/manager.go
index 0f1cfcfdc..6619bf460 100644
--- a/webbrain-systray/internal/d1/manager.go
+++ b/webbrain-systray/internal/d1/manager.go
@@ -123,19 +123,21 @@ type Status struct {
}
type Manager struct {
- mu sync.Mutex
- store *settings.Store
- onChange func()
- phase string
- step string
- progress *download.Progress
- err string
- cancel context.CancelFunc
- eng *engine
- evalMu sync.Mutex
- verified download.Verifier
- requests int64
- latency float64
+ mu sync.Mutex
+ store *settings.Store
+ onChange func()
+ phase string
+ step string
+ progress *download.Progress
+ err string
+ cancel context.CancelFunc
+ installDone chan struct{}
+ removing bool
+ eng *engine
+ evalMu sync.Mutex
+ verified download.Verifier
+ requests int64
+ latency float64
}
func NewManager(store *settings.Store, onChange func()) *Manager {
@@ -270,17 +272,20 @@ func (m *Manager) Install() error {
return errors.New("ONNX Runtime " + ortVersion + " has no build for this platform")
}
m.mu.Lock()
- if m.phase == PhaseDownloading || m.phase == PhaseInstalling || m.phase == PhaseLoading {
+ if m.removing || m.phase == PhaseDownloading || m.phase == PhaseInstalling || m.phase == PhaseLoading {
m.mu.Unlock()
return errors.New("already installing")
}
ctx, cancel := context.WithCancel(context.Background())
m.cancel = cancel
+ done := make(chan struct{})
+ m.installDone = done
m.phase, m.step, m.err, m.progress = PhaseDownloading, "Preparing the decision model", "", nil
m.mu.Unlock()
m.changed()
go func() {
defer cancel()
+ defer close(done)
if err := m.install(ctx, asset); err != nil {
if errors.Is(err, context.Canceled) {
m.set(PhaseIdle, "", nil)
@@ -294,7 +299,10 @@ func (m *Manager) Install() error {
m.set(PhaseIdle, "", nil)
return
}
- _, _ = m.store.Update(func(s *settings.Settings) { s.Decision.Enabled = true })
+ if _, err := m.store.Update(func(s *settings.Settings) { s.Decision.Enabled = true }); err != nil {
+ m.set(PhaseError, "", fmt.Errorf("save decision-model preference: %w", err))
+ return
+ }
if err := m.Load(); err != nil {
logx.Printf("decision model load: %v", err)
}
@@ -442,14 +450,35 @@ func (m *Manager) unload() {
// Remove deletes the model files.
func (m *Manager) Remove() error {
- m.Cancel()
+ m.mu.Lock()
+ if m.removing {
+ m.mu.Unlock()
+ return errors.New("already removing the decision model")
+ }
+ m.removing = true
+ cancel := m.cancel
+ done := m.installDone
+ m.mu.Unlock()
+ defer func() {
+ m.mu.Lock()
+ m.removing = false
+ m.mu.Unlock()
+ }()
+ if cancel != nil {
+ cancel()
+ }
+ if done != nil {
+ <-done
+ }
+ if _, err := m.store.Update(func(s *settings.Settings) { s.Decision.Enabled = false }); err != nil {
+ return err
+ }
m.evalMu.Lock()
defer m.evalMu.Unlock()
m.unload()
if err := os.RemoveAll(modelDir()); err != nil {
return err
}
- _, _ = m.store.Update(func(s *settings.Settings) { s.Decision.Enabled = false })
m.set(PhaseIdle, "", nil)
return nil
}
diff --git a/webbrain-systray/internal/d1/manager_files_test.go b/webbrain-systray/internal/d1/manager_files_test.go
index b3395ea08..af8abe7e3 100644
--- a/webbrain-systray/internal/d1/manager_files_test.go
+++ b/webbrain-systray/internal/d1/manager_files_test.go
@@ -30,6 +30,36 @@ func TestInstallClaimsPhaseBeforeWorkerStarts(t *testing.T) {
}
}
+func TestRemoveWaitsForCanceledInstall(t *testing.T) {
+ t.Setenv("WBC_HOME", t.TempDir())
+ store, err := settings.Open()
+ if err != nil {
+ t.Fatal(err)
+ }
+ m := NewManager(store, nil)
+ installDone := make(chan struct{})
+ canceled := make(chan struct{})
+ m.installDone = installDone
+ m.cancel = func() { close(canceled) }
+ removed := make(chan error, 1)
+ go func() { removed <- m.Remove() }()
+ <-canceled
+ select {
+ case err := <-removed:
+ t.Fatalf("Remove returned before install finished: %v", err)
+ case <-time.After(25 * time.Millisecond):
+ }
+ close(installDone)
+ select {
+ case err := <-removed:
+ if err != nil {
+ t.Fatal(err)
+ }
+ case <-time.After(5 * time.Second):
+ t.Fatal("Remove did not finish after install stopped")
+ }
+}
+
func TestValidFileRejectsSameSizeCorruption(t *testing.T) {
path := filepath.Join(t.TempDir(), "model.data")
good := []byte("pinned model contents")
diff --git a/webbrain-systray/internal/localmodel/manager.go b/webbrain-systray/internal/localmodel/manager.go
index c558b2067..f4a23df42 100644
--- a/webbrain-systray/internal/localmodel/manager.go
+++ b/webbrain-systray/internal/localmodel/manager.go
@@ -301,12 +301,15 @@ func (m *Manager) Install(format string) error {
m.mu.Unlock()
return errors.New("an install is already running")
}
+ if _, err := m.store.Update(func(s *settings.Settings) { s.Local.Format = format }); err != nil {
+ m.mu.Unlock()
+ return err
+ }
ctx, cancel := context.WithCancel(context.Background())
m.cancel = cancel
m.phase, m.step, m.err, m.progress = PhaseDownloading, "Preparing the local model", "", nil
m.mu.Unlock()
m.changed()
- _, _ = m.store.Update(func(s *settings.Settings) { s.Local.Format = format })
go func() {
defer cancel()
@@ -329,7 +332,10 @@ func (m *Manager) Install(format string) error {
m.setPhase(PhaseIdle, "", nil)
return
}
- _, _ = m.store.Update(func(s *settings.Settings) { s.Local.AutoStart = true })
+ if _, err := m.store.Update(func(s *settings.Settings) { s.Local.AutoStart = true }); err != nil {
+ m.setPhase(PhaseError, "", fmt.Errorf("save local-model preference: %w", err))
+ return
+ }
if err := m.Start(); err != nil {
m.setPhase(PhaseError, "", err)
}
@@ -781,6 +787,9 @@ func (m *Manager) Remove(format string) error {
if m.Busy() && !m.Running() {
return errors.New("wait for the current operation to finish")
}
+ if _, err := m.store.Update(func(s *settings.Settings) { s.Local.AutoStart = false }); err != nil {
+ return err
+ }
m.Stop()
switch format {
case "mlx":
@@ -795,7 +804,6 @@ func (m *Manager) Remove(format string) error {
}
}
}
- _, _ = m.store.Update(func(s *settings.Settings) { s.Local.AutoStart = false })
m.setPhase(PhaseIdle, "", nil)
return nil
}
diff --git a/webbrain-systray/internal/localmodel/manager_test.go b/webbrain-systray/internal/localmodel/manager_test.go
index 2e4781332..8343d4289 100644
--- a/webbrain-systray/internal/localmodel/manager_test.go
+++ b/webbrain-systray/internal/localmodel/manager_test.go
@@ -13,6 +13,7 @@ import (
"github.com/esokullu/webbrain-systray/internal/core"
"github.com/esokullu/webbrain-systray/internal/osutil"
+ "github.com/esokullu/webbrain-systray/internal/paths"
"github.com/esokullu/webbrain-systray/internal/settings"
)
@@ -99,6 +100,26 @@ func TestInstallClaimsPhaseBeforeWorkerStarts(t *testing.T) {
}
}
+func TestInstallRejectsFailedSettingsSaveBeforeDownload(t *testing.T) {
+ t.Setenv("WBC_HOME", t.TempDir())
+ store, err := settings.Open()
+ if err != nil {
+ t.Fatal(err)
+ }
+ if err := os.Mkdir(paths.Settings()+".tmp", 0o700); err != nil {
+ t.Fatal(err)
+ }
+ m := NewManager(store, func([]core.LocalUpstream) error { return nil }, nil)
+ if err := m.Install("gguf"); err == nil {
+ t.Fatal("install accepted a format preference that could not be saved")
+ }
+ m.mu.Lock()
+ defer m.mu.Unlock()
+ if m.phase != PhaseIdle || m.cancel != nil {
+ t.Fatal("failed preference save started an install worker")
+ }
+}
+
func TestRuntimeArchivesHavePinnedChecksums(t *testing.T) {
for asset, size := range llamaAssetSizes {
if size <= 0 || len(llamaAssetSHA[asset]) != 64 {