Files
kandev/apps/backend/internal/plugins/store/store.go
T
João Salavisa 5db3e48262 feat: add opt-in plugin auto-updater (#1903)
* feat: add opt-in plugin auto-updater

Automatically update installed plugins in the background, off by default
and opt-in. Builds on the existing verified install pipeline — an
auto-update is just an automatic reinstall of a newer catalog package_url.

Two-tier toggle on Settings > Plugins: an instance-wide default (SQLite
plugin_settings) plus a per-plugin override (tri-state auto_update on the
plugin record, carried forward on upgrade). The AutoUpdatePoller
(~90-min cadence + a boot sweep) upgrades only plugins that are currently
active, opted in, and report update_available; disabled/errored plugins
stay on their installed version.

New endpoints: GET/PUT /api/plugins/settings and
PUT /api/plugins/:id/auto-update.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(plugins): recheck auto-update eligibility at install and fix test mock

Address PR #1903 review feedback:
- Re-check each plugin's current status + effective opt-in immediately before
  InstallFromURL (eligibleForAutoUpdate), closing the TOCTOU window between the
  candidate snapshot / catalog fetch and the install so a plugin disabled or
  opted out mid-sweep is never reinstalled and reactivated.
- Correct the marketplace spec to describe the real failure behavior (shared
  with manual updates) instead of promising a version rollback the install
  pipeline does not perform.
- Fix the frontend CI failure: the plugins page test mocked the whole
  plugins-api module without the new settings/auto-update functions, so
  useAutoUpdateSettings threw at mount.
- Add an aria-label to the per-plugin auto-update Switch and Reset control.
- Add a use-auto-update-settings hook test (load, failure, optimistic setDefault,
  rollback) and an eligibleForAutoUpdate unit test.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 13:04:54 +01:00

69 lines
2.8 KiB
Go

// Package store persists installed plugin records to the filesystem, as
// described in docs/plans/plugins/GRPC-CONTRACT.md §6 ("Package format").
//
// Managed plugins (runtime.type: binary) are gRPC subprocesses spawned by
// kandev — there is no credential machinery here anymore (no api_key, no
// webhook_secret, no HMAC). Auth is the spawn relationship itself plus the
// go-plugin handshake and AutoMTLS. A Record instead tracks where the
// package was extracted to on disk (InstallPath), which version is
// installed, whether the package was signed, and best-effort restart
// bookkeeping for the runtime manager's supervision loop.
package store
import (
"errors"
"time"
"github.com/kandev/kandev/internal/plugins/manifest"
)
// Status values for a plugin registration, per the state machine in
// docs/specs/plugins/spec.md ("State machine").
const (
StatusRegistered = "registered"
StatusActive = "active"
StatusError = "error"
StatusDisabled = "disabled"
StatusUninstalled = "uninstalled"
)
// ErrNotFound is returned by Get, Delete, GetConfig, and SetConfig when no
// record exists for the id.
var ErrNotFound = errors.New("plugin not found")
// Record is a stored plugin installation: the manifest extracted from the
// package, plus the runtime fields kandev manages. Manifest.Version is the
// authoritative installed version (accessible as Record.Version via
// embedding); InstallPath is where pkgtar.Install extracted the package
// (destRoot/<id>/<version>).
type Record struct {
manifest.Manifest `yaml:",inline"`
Status string `yaml:"status" json:"status"`
InstallPath string `yaml:"install_path" json:"install_path"`
Signed bool `yaml:"signed" json:"signed"`
// AutoUpdate is the operator's per-plugin auto-update override. It is a
// tri-state: nil means "inherit the instance-wide default"
// (Service.AutoUpdateDefault), true forces auto-update on for this plugin,
// and false forces it off — either override wins over the global default.
// Persisted so the choice survives restart and, unlike Status, is carried
// over verbatim when a plugin is upgraded in place (see Service.Install).
AutoUpdate *bool `yaml:"auto_update,omitempty" json:"auto_update,omitempty"`
InstalledAt time.Time `yaml:"installed_at" json:"installed_at"`
RestartCount int `yaml:"restart_count" json:"restart_count"`
}
// Store is the persistence interface for plugin installations and their
// operator-editable config.
type Store interface {
List() ([]*Record, error)
Get(id string) (*Record, error)
Save(record *Record) error
Delete(id string) error
GetConfig(id string) (map[string]any, error)
SetConfig(id string, config map[string]any) error
}
// _ compile-time asserts that FSStore (fs_store.go) implements Store.
var _ Store = (*FSStore)(nil)