feat: support setting the MQTT client ID separately

Author: bclswl0827

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 Starting from v2.2.5, all notable changes to this project will be documented in this file.
 
+## v4.3.4
+
+### Release Notes
+
+This release focuses on **MQTT connectivity robustness and operational convenience**, introducing **configurable MQTT Client ID support** and **in-app restart capability**.
+
+By allowing explicit control over the **MQTT Client ID**, AnyShake Observer can now avoid client collisions and better integrate with managed brokers and shared infrastructures. In addition, the new **in-app restart mechanism** improves maintainability by enabling controlled restarts without external process management.
+
+### New Features
+
+- Added support for **configurable MQTT Client ID**, allowing users to explicitly define the client identifier used when connecting to the MQTT broker.
+- Added support for **in-app restart**, enabling the service to restart itself without external supervisors or manual intervention.
+
 ## v4.3.3
 
 ### Release Notes

Makefile

@@ -1,6 +1,6 @@
 CURRENT_VERSION_MAJOR = 4
 CURRENT_VERSION_MINOR = 3
-CURRENT_VERSION_PATCH = 3
+CURRENT_VERSION_PATCH = 4
 
 REQUIRED_VERSION_MAJOR = 4
 REQUIRED_VERSION_MINOR = 3

internal/service/quakesense/config.go

@@ -253,6 +253,59 @@ func (s *quakeSenseConfigMqttPasswordImpl) Restore(handler *action.Handler) erro
 	return nil
 }
 
+type quakeSenseConfigMqttClientIdImpl struct{}
+
+func (s *quakeSenseConfigMqttClientIdImpl) GetName() string             { return "MQTT Client ID" }
+func (s *quakeSenseConfigMqttClientIdImpl) GetNamespace() string        { return ID }
+func (s *quakeSenseConfigMqttClientIdImpl) GetKey() string              { return "mqtt_client_id" }
+func (s *quakeSenseConfigMqttClientIdImpl) GetType() action.SettingType { return action.String }
+func (s *quakeSenseConfigMqttClientIdImpl) IsRequired() bool            { return true }
+func (s *quakeSenseConfigMqttClientIdImpl) GetVersion() int             { return 0 }
+func (s *quakeSenseConfigMqttClientIdImpl) GetOptions() map[string]any  { return nil }
+func (s *quakeSenseConfigMqttClientIdImpl) GetDefaultValue() any {
+	b := make([]byte, 4)
+	if _, err := crypto_rand.Read(b); err != nil {
+		return fmt.Sprintf("anyshake-observer-%x", uint32(time.Now().UnixNano()))
+	}
+	return fmt.Sprintf("anyshake-observer-%x", b)
+}
+func (s *quakeSenseConfigMqttClientIdImpl) GetDescription() string {
+	return "MQTT Client ID uniquely identifies a client when connecting to the broker. By default, it is anyshake-observer-<random string>."
+}
+func (s *quakeSenseConfigMqttClientIdImpl) Init(handler *action.Handler) error {
+	if _, err := handler.SettingsInit(s.GetNamespace(), s.GetKey(), s.GetType(), s.GetVersion(), s.GetDefaultValue()); err != nil {
+		return fmt.Errorf("failed to set default MQTT client ID: %w", err)
+	}
+	return nil
+}
+func (s *quakeSenseConfigMqttClientIdImpl) Set(handler *action.Handler, newVal any) error {
+	topic, err := config.GetConfigValString(newVal)
+	if err != nil {
+		return err
+	}
+	if err := handler.SettingsSet(s.GetNamespace(), s.GetKey(), s.GetType(), s.GetVersion(), topic); err != nil {
+		return fmt.Errorf("failed to set MQTT client ID: %w", err)
+	}
+	return nil
+}
+func (s *quakeSenseConfigMqttClientIdImpl) Get(handler *action.Handler) (any, error) {
+	val, _, _, err := handler.SettingsGet(s.GetNamespace(), s.GetKey())
+	if err != nil {
+		return nil, fmt.Errorf("failed to get MQTT client ID: %w", err)
+	}
+	id, ok := val.(string)
+	if !ok {
+		return nil, errors.New("string expected")
+	}
+	return id, nil
+}
+func (s *quakeSenseConfigMqttClientIdImpl) Restore(handler *action.Handler) error {
+	if err := handler.SettingsSet(s.GetNamespace(), s.GetKey(), s.GetType(), s.GetVersion(), s.GetDefaultValue()); err != nil {
+		return fmt.Errorf("failed to reset MQTT client ID: %w", err)
+	}
+	return nil
+}
+
 type quakeSenseConfigMonitorChannelImpl struct{}
 
 func (s *quakeSenseConfigMonitorChannelImpl) GetName() string             { return "Monitor Channel" }
@@ -787,6 +840,7 @@ func (s *QuakeSenseServiceImpl) GetConfigConstraint() []config.IConstraint {
 		&quakeSenseConfigMqttTopicImpl{},
 		&quakeSenseConfigMqttUsernameImpl{},
 		&quakeSenseConfigMqttPasswordImpl{},
+		&quakeSenseConfigMqttClientIdImpl{},
 		&quakeSenseConfigMonitorChannelImpl{},
 		&quakeSenseConfigFilterTypeImpl{},
 		&quakeSenseConfigMinFreqImpl{},

internal/service/quakesense/init.go

@@ -40,6 +40,12 @@ func (s *QuakeSenseServiceImpl) Init() error {
 	}
 	s.mqttPassword = mqttPassword.(string)
 
+	mqttClientId, err := (&quakeSenseConfigMqttClientIdImpl{}).Get(s.actionHandler)
+	if err != nil {
+		return fmt.Errorf("failed to get quakeSense MQTT client ID: %w", err)
+	}
+	s.mqttClientId = mqttClientId.(string)
+
 	stationName, err := (&config.StationNameConfigConstraintImpl{}).Get(s.actionHandler)
 	if err != nil {
 		return fmt.Errorf("failed to get quakeSense station name: %w", err)

internal/service/quakesense/start.go

@@ -32,7 +32,7 @@ func (s *QuakeSenseServiceImpl) Start() error {
 	mqttClientOptions.AddBroker(s.mqttBroker)
 	mqttClientOptions.SetAutoReconnect(true)
 	mqttClientOptions.SetKeepAlive(30 * time.Second)
-	mqttClientOptions.SetClientID("anyshake-observer")
+	mqttClientOptions.SetClientID(s.mqttClientId)
 	mqttClientOptions.SetConnectTimeout(10 * time.Second)
 	if s.mqttUsername != "" && s.mqttPassword != "" {
 		mqttClientOptions.SetUsername(s.mqttUsername)

internal/service/quakesense/types.go

@@ -49,6 +49,7 @@ type QuakeSenseServiceImpl struct {
 	mqttTopic    string
 	mqttUsername string
 	mqttPassword string
+	mqttClientId string
 	mqttClient   mqtt.Client
 
 	stationName        string