feat(components/preferences)!: restructure sensor/control preferences

- sensors and controls preferences are now split under [sensors] and [controls] in the preferences file - preferences are grouped under [sensors]/[controls] by the worker that produces them, in user-friendly sub-groups BREAKING CHANGE: Sensors and (MQTT) controls preferences have been restructured in the preferences file. Users who have customised any sensor/control preferences will need to manually migrate the changes to the new structure.
joshuar · Feb 1, 2025 · 5376ce1 · 5376ce1
1 parent 101b2a8
commit 5376ce1
Show file tree

Hide file tree

Showing 47 changed files with 156 additions and 87 deletions.
diff --git a/internal/agent/agentsensor/connection_latency.go b/internal/agent/agentsensor/connection_latency.go
@@ -62,7 +62,7 @@ type ConnectionLatencySensorWorker struct {
 }
 
 func (w *ConnectionLatencySensorWorker) PreferencesID() string {
-	return "connection_latency_sensor"
+	return preferences.SensorsPrefPrefix + "agent" + preferences.PathDelim + "connection_latency"
 }
 
 func (w *ConnectionLatencySensorWorker) DefaultPreferences() preferences.CommonWorkerPrefs {

diff --git a/internal/agent/agentsensor/external_ip.go b/internal/agent/agentsensor/external_ip.go
@@ -73,7 +73,7 @@ type ExternalIPWorker struct {
 }
 
 func (w *ExternalIPWorker) PreferencesID() string {
-	return "external_ip_sensor"
+	return preferences.SensorsPrefPrefix + "agent" + preferences.PathDelim + "external_ip"
 }
 
 func (w *ExternalIPWorker) DefaultPreferences() preferences.CommonWorkerPrefs {

diff --git a/internal/agent/agentsensor/version.go b/internal/agent/agentsensor/version.go
@@ -34,7 +34,7 @@ type VersionWorker struct {
 }
 
 func (w *VersionWorker) PreferencesID() string {
-	return "version_sensor"
+	return preferences.SensorsPrefPrefix + "agent" + preferences.PathDelim + "version"
 }
 
 func (w *VersionWorker) DefaultPreferences() preferences.CommonWorkerPrefs {

diff --git a/internal/agent/workers_linux.go b/internal/agent/workers_linux.go
@@ -13,7 +13,6 @@ import (
 	"github.com/joshuar/go-hass-agent/internal/hass/event"
 	"github.com/joshuar/go-hass-agent/internal/hass/sensor"
 	"github.com/joshuar/go-hass-agent/internal/linux"
-	"github.com/joshuar/go-hass-agent/internal/linux/apps"
 	"github.com/joshuar/go-hass-agent/internal/linux/battery"
 	"github.com/joshuar/go-hass-agent/internal/linux/cpu"
 	"github.com/joshuar/go-hass-agent/internal/linux/desktop"
@@ -27,13 +26,13 @@ import (
 
 // sensorEventWorkersInitFuncs are all of the sensor workers that generate sensors on events.
 var sensorEventWorkersInitFuncs = []func(ctx context.Context) (*linux.EventSensorWorker, error){
-	apps.NewAppWorker,
 	battery.NewBatteryWorker,
 	net.NewConnectionWorker,
 	net.NewAddressWorker,
 	power.NewProfileWorker,
 	power.NewStateWorker,
 	power.NewScreenLockWorker,
+	desktop.NewAppWorker,
 	desktop.NewDesktopWorker,
 }
 

diff --git a/internal/components/preferences/preferences.go b/internal/components/preferences/preferences.go
@@ -44,6 +44,7 @@ const (
 	defaultMQTTTopicPrefix = "homeassistant"
 	defaultMQTTServer      = "tcp://localhost:1883"
 	DefaultAppID           = "go-hass-agent"
+	PathDelim              = "."
 )
 
 // preferences defines all preferences for Go Hass Agent.
@@ -58,7 +59,7 @@ type preferences struct {
 
 var (
 	// Package level internal variables.
-	prefsSrc  = koanf.New(".")
+	prefsSrc  = koanf.New(PathDelim)
 	mu        = sync.Mutex{}
 	prefsFile string
 	logger    *slog.Logger

diff --git a/internal/components/preferences/worker.go b/internal/components/preferences/worker.go
@@ -15,7 +15,8 @@ import (
 )
 
 const (
-	workerPrefsPrefix = "worker"
+	SensorsPrefPrefix  = "sensors" + PathDelim
+	ControlsPrefPrefix = "controls" + PathDelim
 )
 
 // CommonWorkerPrefs contains worker preferences that all workers can/should
@@ -52,7 +53,7 @@ func LoadWorker[T any](worker Worker[T]) (*T, error) {
 	// Get the default preferences.
 	defaultPrefs = worker.DefaultPreferences()
 	// Set the key to the worker preferences in the preferences store.
-	prefsKey := workerPrefsPrefix + "." + worker.PreferencesID()
+	prefsKey := worker.PreferencesID()
 	// Try to retrieve any existing preferences. Use those if possible.
 	foundPrefs := prefsSrc.Get(prefsKey)
 	if foundPrefs != nil {
@@ -108,7 +109,7 @@ func SaveWorker[T any](worker Worker[T], prefs T) error {
 		return fmt.Errorf("%w: %w", ErrSaveWorkerPrefs, err)
 	}
 	// Merge the worker preferences into the preferences file.
-	if err := prefsSrc.Set(workerPrefsPrefix+"."+worker.PreferencesID(), prefsMaps); err != nil {
+	if err := prefsSrc.Set(worker.PreferencesID(), prefsMaps); err != nil {
 		return fmt.Errorf("%w: %w", ErrSaveWorkerPrefs, err)
 	}
 	// Save the preferences.

diff --git a/internal/linux/battery/preferences.go b/internal/linux/battery/preferences.go
@@ -6,7 +6,7 @@ package battery
 import "github.com/joshuar/go-hass-agent/internal/components/preferences"
 
 const (
-	preferencesID = "battery_sensors"
+	preferencesID = preferences.SensorsPrefPrefix + "batteries"
 )
 
 type WorkerPrefs struct {

diff --git a/internal/linux/cpu/freqWorker.go b/internal/linux/cpu/freqWorker.go
@@ -21,7 +21,7 @@ const (
 	cpuFreqUpdateJitter   = time.Second
 
 	cpuFreqWorkerID      = "cpu_freq_sensors"
-	cpuFreqPreferencesID = "freq"
+	cpuFreqPreferencesID = prefPrefix + "frequencies"
 )
 
 type freqWorker struct{}
@@ -39,7 +39,7 @@ func (w *freqWorker) Sensors(_ context.Context) ([]sensor.Entity, error) {
 }
 
 func (w *freqWorker) PreferencesID() string {
-	return basePreferencesID + "." + cpuFreqPreferencesID
+	return cpuFreqPreferencesID
 }
 
 func (w *freqWorker) DefaultPreferences() FreqWorkerPrefs {

diff --git a/internal/linux/cpu/loadAvgs.go b/internal/linux/cpu/loadAvgs.go
@@ -33,7 +33,7 @@ const (
 	loadAvgsTotal = 3
 
 	loadAvgsWorkerID      = "cpu_loadavg_sensors"
-	loadAvgsPreferencesID = "loadavg"
+	loadAvgsPreferencesID = prefPrefix + "load_averages"
 )
 
 var ErrParseLoadAvgs = errors.New("could not parse load averages")
@@ -67,7 +67,7 @@ func (w *loadAvgsWorker) Sensors(_ context.Context) ([]sensor.Entity, error) {
 }
 
 func (w *loadAvgsWorker) PreferencesID() string {
-	return basePreferencesID + "." + loadAvgsPreferencesID
+	return loadAvgsPreferencesID
 }
 
 func (w *loadAvgsWorker) DefaultPreferences() preferences.CommonWorkerPrefs {

diff --git a/internal/linux/cpu/preferences.go b/internal/linux/cpu/preferences.go
@@ -6,7 +6,7 @@ package cpu
 import "github.com/joshuar/go-hass-agent/internal/components/preferences"
 
 const (
-	basePreferencesID = "cpu_sensors"
+	prefPrefix = preferences.SensorsPrefPrefix + "cpu" + preferences.PathDelim
 )
 
 // FreqWorkerPrefs are the preferences for the CPU frequency worker.

diff --git a/internal/linux/cpu/usageWorker.go b/internal/linux/cpu/usageWorker.go
@@ -26,7 +26,7 @@ const (
 	cpuUsageUpdateJitter   = 500 * time.Millisecond
 
 	cpuUsageWorkerID      = "cpu_usage_sensors"
-	cpuUsagePreferencesID = "usage"
+	cpuUsagePreferencesID = prefPrefix + "usage"
 )
 
 type usageWorker struct {
@@ -47,7 +47,7 @@ func (w *usageWorker) Sensors(_ context.Context) ([]sensor.Entity, error) {
 }
 
 func (w *usageWorker) PreferencesID() string {
-	return basePreferencesID + "." + cpuUsagePreferencesID
+	return cpuUsagePreferencesID
 }
 
 func (w *usageWorker) DefaultPreferences() UsagePrefs {

diff --git a/internal/linux/apps/apps.go → internal/linux/desktop/apps.go b/internal/linux/apps/apps.go → internal/linux/desktop/apps.go
@@ -4,7 +4,7 @@
 // https://opensource.org/licenses/MIT
 
 //revive:disable:unused-receiver
-package apps
+package desktop
 
 import (
 	"context"
@@ -27,7 +27,7 @@ const (
 	appStateDBusInterface = "org.freedesktop.impl.portal.Background"
 	appStateDBusEvent     = "org.freedesktop.impl.portal.Background.RunningApplicationsChanged"
 
-	workerID = "app_sensors"
+	appWorkerID = "app_sensors"
 
 	activeAppsIcon = "mdi:application"
 	activeAppsName = "Active App"
@@ -41,10 +41,8 @@ const (
 
 var ErrNoApps = errors.New("no running apps")
 
-type WorkerPrefs preferences.CommonWorkerPrefs
-
 func (w *sensorWorker) PreferencesID() string {
-	return workerID
+	return prefPrefix + "app"
 }
 
 func (w *sensorWorker) DefaultPreferences() WorkerPrefs {
@@ -60,7 +58,7 @@ type sensorWorker struct {
 
 func (w *sensorWorker) Events(ctx context.Context) (<-chan sensor.Entity, error) {
 	sensorCh := make(chan sensor.Entity)
-	logger := slog.Default().With(slog.String("worker", workerID))
+	logger := slog.Default().With(slog.String("worker", desktopWorkerID))
 
 	sendSensors := func(ctx context.Context, sensorCh chan sensor.Entity) {
 		appSensors, err := w.Sensors(ctx)
@@ -154,7 +152,7 @@ func (w *sensorWorker) Sensors(_ context.Context) ([]sensor.Entity, error) {
 }
 
 func NewAppWorker(ctx context.Context) (*linux.EventSensorWorker, error) {
-	worker := linux.NewEventSensorWorker(workerID)
+	worker := linux.NewEventSensorWorker(appWorkerID)
 
 	// If we cannot find a portal interface, we cannot monitor the active app.
 	portalDest, ok := linux.CtxGetDesktopPortal(ctx)

diff --git a/internal/linux/desktop/desktop.go b/internal/linux/desktop/desktop.go
@@ -31,7 +31,8 @@ const (
 	colorSchemeProp         = "color-scheme"
 	accentColorProp         = "accent-color"
 
-	workerID = "desktop_settings_sensors"
+	desktopWorkerID     = "desktop_settings_sensors"
+	desktopWorkerPrefID = prefPrefix + "preferences"
 )
 
 var ErrUnknownProp = errors.New("unknown desktop property")
@@ -43,7 +44,7 @@ type settingsWorker struct {
 }
 
 func (w *settingsWorker) PreferencesID() string {
-	return preferencesID
+	return desktopWorkerPrefID
 }
 
 func (w *settingsWorker) DefaultPreferences() WorkerPrefs {
@@ -53,7 +54,7 @@ func (w *settingsWorker) DefaultPreferences() WorkerPrefs {
 //nolint:cyclop,gocognit
 func (w *settingsWorker) Events(ctx context.Context) (<-chan sensor.Entity, error) {
 	sensorCh := make(chan sensor.Entity)
-	logger := logging.FromContext(ctx).With(slog.String("worker", workerID))
+	logger := logging.FromContext(ctx).With(slog.String("worker", desktopWorkerID))
 
 	go func() {
 		defer close(sensorCh)
@@ -160,7 +161,7 @@ func (w *settingsWorker) Sensors(ctx context.Context) ([]sensor.Entity, error) {
 func NewDesktopWorker(ctx context.Context) (*linux.EventSensorWorker, error) {
 	var err error
 
-	worker := linux.NewEventSensorWorker(workerID)
+	worker := linux.NewEventSensorWorker(desktopWorkerID)
 
 	_, ok := linux.CtxGetDesktopPortal(ctx)
 	if !ok {

diff --git a/internal/linux/desktop/preferences.go b/internal/linux/desktop/preferences.go
@@ -6,7 +6,7 @@ package desktop
 import "github.com/joshuar/go-hass-agent/internal/components/preferences"
 
 const (
-	preferencesID = "desktop_sensors"
+	prefPrefix = preferences.SensorsPrefPrefix + "desktop" + preferences.PathDelim
 )
 
 type WorkerPrefs struct {

diff --git a/internal/linux/disk/ioWorker.go b/internal/linux/disk/ioWorker.go
@@ -116,7 +116,7 @@ func (w *ioWorker) Sensors(ctx context.Context) ([]sensor.Entity, error) {
 }
 
 func (w *ioWorker) PreferencesID() string {
-	return basePreferencesID + "." + ioWorkerPreferencesID
+	return ioWorkerPreferencesID
 }
 
 func (w *ioWorker) DefaultPreferences() WorkerPrefs {

diff --git a/internal/linux/disk/preferences.go b/internal/linux/disk/preferences.go
@@ -6,9 +6,9 @@ package disk
 import "github.com/joshuar/go-hass-agent/internal/components/preferences"
 
 const (
-	basePreferencesID        = "disk_sensors"
-	ioWorkerPreferencesID    = "io_sensors"
-	usageWorkerPreferencesID = "usage_sensors"
+	prefPrefix               = preferences.SensorsPrefPrefix + "disk" + preferences.PathDelim
+	ioWorkerPreferencesID    = prefPrefix + "rates"
+	usageWorkerPreferencesID = prefPrefix + "usage"
 )
 
 type WorkerPrefs struct {

diff --git a/internal/linux/disk/usageWorker.go b/internal/linux/disk/usageWorker.go
@@ -45,7 +45,7 @@ func (w *usageWorker) Sensors(ctx context.Context) ([]sensor.Entity, error) {
 }
 
 func (w *usageWorker) PreferencesID() string {
-	return basePreferencesID + "." + usageWorkerPreferencesID
+	return usageWorkerPreferencesID
 }
 
 func (w *usageWorker) DefaultPreferences() WorkerPrefs {

diff --git a/internal/linux/location/location.go b/internal/linux/location/location.go
@@ -36,7 +36,7 @@ const (
 	locationUpdatedSignal = clientInterface + ".LocationUpdated"
 
 	workerID      = "location_worker"
-	preferencesID = "location"
+	preferencesID = preferences.SensorsPrefPrefix + "location"
 )
 
 type locationWorker struct {

diff --git a/internal/linux/media/camera.go b/internal/linux/media/camera.go
@@ -33,7 +33,7 @@ const (
 	defaultHeight       uint32 = 640
 	defaultWidth        uint32 = 480
 
-	cameraPreferencesID = "camera_controls"
+	cameraPreferencesID = preferences.ControlsPrefPrefix + "media" + preferences.PathDelim + "video"
 )
 
 var defaultPreferredFmts = []string{"Motion-JPEG"}

diff --git a/internal/linux/media/mpris.go b/internal/linux/media/mpris.go
@@ -29,7 +29,7 @@ const (
 	mprisDBusPath      = "/org/mpris/MediaPlayer2"
 	mprisDBusNamespace = "org.mpris.MediaPlayer2.Player"
 
-	mprisPreferencesID = "mpris"
+	mprisPreferencesID = preferences.SensorsPrefPrefix + "media" + preferences.PathDelim + "mpris"
 )
 
 type mprisMonitor struct {

diff --git a/internal/linux/media/volume.go b/internal/linux/media/volume.go
@@ -30,7 +30,7 @@ const (
 	maxVolpc  = 100
 	volStepPc = 1
 
-	audioControlPreferencesID = "audio_controls"
+	audioControlPreferencesID = preferences.ControlsPrefPrefix + "media" + preferences.PathDelim + "audio"
 )
 
 // audioControl is a struct containing the data for providing audio state

diff --git a/internal/linux/mem/memUsage.go b/internal/linux/mem/memUsage.go
@@ -32,7 +32,7 @@ const (
 	memoryUsageSensorPcUnits = "%"
 
 	memUsageWorkerID      = "memory_usage_sensors"
-	memUsagePreferencesID = memUsageWorkerID
+	memUsagePreferencesID = prefPrefix + "usage"
 )
 
 // Lists of the memory statistics we want to track as sensors. See /proc/meminfo

diff --git a/internal/linux/mem/oomEvents.go b/internal/linux/mem/oomEvents.go
@@ -19,7 +19,7 @@ import (
 
 const (
 	oomEventsWorkerID      = "oom_events"
-	oomEventsPreferencesID = oomEventsWorkerID
+	oomEventsPreferencesID = prefPrefix + "oom_events"
 	oomDBusPath            = "/org/freedesktop/systemd1/unit"
 	unitPathPrefix         = "/org/freedesktop/systemd1/unit"
 	oomEventName           = "oom_event"

diff --git a/internal/linux/mem/preferences.go b/internal/linux/mem/preferences.go
@@ -5,6 +5,10 @@ package mem
 
 import "github.com/joshuar/go-hass-agent/internal/components/preferences"
 
+const (
+	prefPrefix = preferences.SensorsPrefPrefix + "memory" + preferences.PathDelim
+)
+
 type WorkerPreferences struct {
 	preferences.CommonWorkerPrefs
 	UpdateInterval string `toml:"update_interval" comment:"Time between updates of sensors."`

diff --git a/internal/linux/net/dbusConnectionState.go b/internal/linux/net/dbusConnectionState.go
@@ -34,6 +34,7 @@ const (
 	activeConnectionsProp  = "ActivatingConnection"
 
 	netConnWorkerID = "network_connection_sensors"
+	netConnPrefID   = prefPrefix + "connections"
 )
 
 type ConnectionsWorker struct {
@@ -134,13 +135,12 @@ func (w *ConnectionsWorker) Events(ctx context.Context) (<-chan sensor.Entity, e
 }
 
 func (w *ConnectionsWorker) PreferencesID() string {
-	return preferencesID
+	return netConnPrefID
 }
 
 func (w *ConnectionsWorker) DefaultPreferences() WorkerPrefs {
 	return WorkerPrefs{
 		IgnoredDevices: defaultIgnoredDevices,
-		UpdateInterval: rateInterval.String(),
 	}
 }