- added clean session to env variables

- automatically put clean session to false if file message persistence enabled - updated doc Signed-off-by: PricelessRabbit <[email protected]>
absmach · Nov 25, 2020 · b9975c6 · b9975c6
1 parent adad67d
commit b9975c6
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -126,6 +126,7 @@ The service is configured using the environment variables presented in the follo
 | MF_EXPORT_MQTT_CLIENT_PK      | Client key for authentication in case when MTLS = true                                  | thing.key             |
 | MF_EXPORT_MQTT_QOS            | MQTT QOS                                                                                | 0                     |
 | MF_EXPORT_MQTT_RETAIN         | MQTT retain                                                                             | false                 |
+| MF_EXPORT_MQTT_CLEAN_SESSION  | MQTT clean session                                                                      | false                 |
 | MF_EXPORT_MQTT_PERSIST        | persist MQTT QOS 2 pending messages in filesystem, to avoid data loss                   | false                 |
 | MF_EXPORT_MQTT_PERSIST_DIR    | directory in which pending messages will be saved if persist is enabled                 | false                 |
 | MF_EXPORT_CONFIG_FILE         | Configuration file                                                                      | config.toml           |

diff --git a/cmd/main.go b/cmd/main.go
@@ -29,24 +29,25 @@ import (
 )
 
 const (
-	svcName           = "export"
-	defNatsURL        = nats.DefaultURL
-	defLogLevel       = "debug"
-	defPort           = "8170"
-	defMqttHost       = "tcp://localhost:1883"
-	defMqttUsername   = ""
-	defMqttPassword   = ""
-	defMqttChannel    = ""
-	defMqttSkipTLSVer = "true"
-	defMqttMTLS       = "false"
-	defMqttCA         = "ca.crt"
-	defMqttQoS        = "0"
-	defMqttRetain     = "false"
-	defMqttPersist    = "false"
-	defMqttPersistDir = "../mqtt_persist"
-	defMqttCert       = "thing.cert"
-	defMqttPrivKey    = "thing.key"
-	defConfigFile     = "../configs/config.toml"
+	svcName             = "export"
+	defNatsURL          = nats.DefaultURL
+	defLogLevel         = "debug"
+	defPort             = "8170"
+	defMqttHost         = "tcp://localhost:1883"
+	defMqttUsername     = ""
+	defMqttPassword     = ""
+	defMqttChannel      = ""
+	defMqttSkipTLSVer   = "true"
+	defMqttMTLS         = "false"
+	defMqttCA           = "ca.crt"
+	defMqttQoS          = "0"
+	defMqttRetain       = "false"
+	defMqttCleanSession = "true"
+	defMqttPersist      = "false"
+	defMqttPersistDir   = "../mqtt_persist"
+	defMqttCert         = "thing.cert"
+	defMqttPrivKey      = "thing.key"
+	defConfigFile       = "../configs/config.toml"
 
 	defCacheURL  = "localhost:6379"
 	defCachePass = ""
@@ -56,20 +57,21 @@ const (
 	envLogLevel = "MF_EXPORT_LOG_LEVEL"
 	envPort     = "MF_EXPORT_PORT"
 
-	envMqttHost       = "MF_EXPORT_MQTT_HOST"
-	envMqttUsername   = "MF_EXPORT_MQTT_USERNAME"
-	envMqttPassword   = "MF_EXPORT_MQTT_PASSWORD"
-	envMqttChannel    = "MF_EXPORT_MQTT_CHANNEL"
-	envMqttSkipTLSVer = "MF_EXPORT_MQTT_SKIP_TLS"
-	envMqttMTLS       = "MF_EXPORT_MQTT_MTLS"
-	envMqttCA         = "MF_EXPORT_MQTT_CA"
-	envMqttQoS        = "MF_EXPORT_MQTT_QOS"
-	envMqttRetain     = "MF_EXPORT_MQTT_RETAIN"
-	envMqttPersist    = "MF_MQTT_PERSIST"
-	envMqttPersistDir = "MF_MQTT_PERSIST_FILE"
-	envMqttCert       = "MF_EXPORT_MQTT_CLIENT_CERT"
-	envMqttPrivKey    = "MF_EXPORT_MQTT_CLIENT_PK"
-	envConfigFile     = "MF_EXPORT_CONFIG_FILE"
+	envMqttHost         = "MF_EXPORT_MQTT_HOST"
+	envMqttUsername     = "MF_EXPORT_MQTT_USERNAME"
+	envMqttPassword     = "MF_EXPORT_MQTT_PASSWORD"
+	envMqttChannel      = "MF_EXPORT_MQTT_CHANNEL"
+	envMqttSkipTLSVer   = "MF_EXPORT_MQTT_SKIP_TLS"
+	envMqttMTLS         = "MF_EXPORT_MQTT_MTLS"
+	envMqttCA           = "MF_EXPORT_MQTT_CA"
+	envMqttQoS          = "MF_EXPORT_MQTT_QOS"
+	envMqttRetain       = "MF_EXPORT_MQTT_RETAIN"
+	envMqttCleanSession = "MF_EXPORT_MQTT_CLEAN_SESSION"
+	envMqttPersist      = "MF_MQTT_PERSIST"
+	envMqttPersistDir   = "MF_MQTT_PERSIST_FILE"
+	envMqttCert         = "MF_EXPORT_MQTT_CLIENT_CERT"
+	envMqttPrivKey      = "MF_EXPORT_MQTT_CLIENT_PK"
+	envConfigFile       = "MF_EXPORT_CONFIG_FILE"
 
 	envCacheURL  = "MF_EXPORT_CACHE_URL"
 	envCachePass = "MF_EXPORT_CACHE_PASS"
@@ -149,6 +151,10 @@ func loadConfigs() (exp.Config, error) {
 		if err != nil {
 			mqttRetain = false
 		}
+		mqttCleanSession, err := strconv.ParseBool(mainflux.Env(envMqttCleanSession, defMqttCleanSession))
+		if err != nil {
+			mqttRetain = false
+		}
 		mqttPersist, err := strconv.ParseBool(mainflux.Env(envMqttPersist, defMqttPersist))
 		if err != nil {
 			mqttPersist = false
@@ -174,12 +180,13 @@ func loadConfigs() (exp.Config, error) {
 			Password: mainflux.Env(envMqttPassword, defMqttPassword),
 			Username: mainflux.Env(envMqttUsername, defMqttUsername),
 
-			Retain:     mqttRetain,
-			Persist:    mqttPersist,
-			PersistDir: mainflux.Env(envMqttPersistDir, defMqttPersistDir),
-			QoS:        QoS,
-			MTLS:       mqttMTLS,
-			SkipTLSVer: mqttSkipTLSVer,
+			Retain:       mqttRetain,
+			CleanSession: mqttCleanSession,
+			Persist:      mqttPersist,
+			PersistDir:   mainflux.Env(envMqttPersistDir, defMqttPersistDir),
+			QoS:          QoS,
+			MTLS:         mqttMTLS,
+			SkipTLSVer:   mqttSkipTLSVer,
 
 			CAPath:            mainflux.Env(envMqttCA, defMqttCA),
 			ClientCertPath:    mainflux.Env(envMqttCert, defMqttCert),

diff --git a/configs/config.toml b/configs/config.toml
@@ -19,6 +19,7 @@ File = "/configs/export/config.toml"
   password = ""
   qos = 0
   retain = false
+  clean_session = true
   persist = false
   persist_dir = "../mqtt_persist"
   skip_tls_ver = true

diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -31,6 +31,7 @@ type MQTT struct {
 	MTLS              bool            `json:"mtls" toml:"mtls" mapstructure:"mtls"`
 	SkipTLSVer        bool            `json:"skip_tls_ver" toml:"skip_tls_ver" mapstructure:"skip_tls_ver"`
 	Retain            bool            `json:"retain" toml:"retain" mapstructure:"retain"`
+	CleanSession      bool            `json:"clean_session" toml:"clean_session" mapstructure:"clean_session"`
 	Persist           bool            `json:"persist" toml:"persist" mapstructure:"persist"`
 	PersistDir        string          `json:"persist_dir" toml:"persist_dir" mapstructure:"persist_dir"`
 	QoS               int             `json:"qos" toml:"qos" mapstructure:"qos"`

diff --git a/pkg/export/service.go b/pkg/export/service.go
@@ -162,14 +162,16 @@ func (e *exporter) mqttConnect(conf config.Config, logger logger.Logger) (mqtt.C
 	opts := mqtt.NewClientOptions().
 		AddBroker(conf.MQTT.Host).
 		SetClientID(e.id).
-		SetCleanSession(false).
+		SetCleanSession(conf.MQTT.CleanSession).
 		SetAutoReconnect(true).
 		SetOnConnectHandler(e.conn).
 		SetConnectionLostHandler(e.lost)
 
 	if conf.MQTT.Persist {
 		store := mqtt.NewFileStore(conf.MQTT.PersistDir)
 		opts.SetStore(store)
+		//disable clean session because paho deletes stored messages when restarts
+		opts.SetCleanSession(false)
 	}
 
 	if conf.MQTT.Username != "" && conf.MQTT.Password != "" {