Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

MQTT client and UserAssetProvisioningMQTTHandler updates to improve connection robustness

Rich Turner60c35aff9f4e
diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
index d691d2107..1f039cb52 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
@@ -337,7 +337,7 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S
LOG.info("Establishing connection: " + getClientUri());
Mqtt3ConnectBuilder.Send<CompletableFuture<Mqtt3ConnAck>> completableFutureSend = client.connectWith()
- .cleanSession(cleanSession)
+ .cleanSession(true) // Always clean session as there's some inconsistency in how HiveMQ client handles this on reconnects
.keepAlive(5);
if (usernamePassword != null) {
@@ -371,6 +371,10 @@ public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S
}
protected void onConnectionStatusChanged(ConnectionStatus connectionStatus) {
+ if (this.connectionStatus == connectionStatus) {
+ return;
+ }
+
this.connectionStatus = connectionStatus;
executorService.submit(() -> {
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/MqttConnection.java b/manager/src/main/java/org/openremote/manager/mqtt/MqttConnection.java
index 9602f403d..fd6191ebb 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/MqttConnection.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/MqttConnection.java
@@ -10,6 +10,7 @@ import org.openremote.model.auth.OAuthClientCredentialsGrant;
import org.openremote.model.auth.OAuthGrant;
import org.openremote.model.util.TextUtil;
+import java.util.Objects;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -118,4 +119,17 @@ public class MqttConnection {
", clientId='" + clientId + '\'' +
'}';
}
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ MqttConnection that = (MqttConnection) o;
+ return Objects.equals(realm, that.realm) && Objects.equals(username, that.username) && clientId.equals(that.clientId);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(realm, username, clientId);
+ }
}
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java b/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java
index fa3542882..1ee482077 100644
--- a/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java
+++ b/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java
@@ -57,6 +57,18 @@ public class ORAuthorizatorPolicy implements IAuthorizatorPolicy {
@SuppressWarnings({"rawtypes", "unchecked"})
protected boolean verifyRights(Topic topic, String clientId, String realm, String username, boolean isWrite) {
MqttConnection connection = brokerService.clientIdConnectionMap.get(clientId);
+ int i=0;
+
+ try {
+ while (connection == null && i<10) {
+ // The connection handler gets called after this quite often so try and wait until the connection is registered
+ connection = brokerService.clientIdConnectionMap.get(clientId);
+ i++;
+ Thread.sleep(100);
+ }
+ } catch (InterruptedException e) {
+ LOG.finer("Interrupted whilst waiting for connection to be initialised: clientId=" + clientId);
+ }
if (connection == null) {
LOG.warning("No connection found: clientId=" + clientId);
diff --git a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
index 500ce9d40..b59a27908 100644
--- a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
+++ b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java
@@ -347,16 +347,18 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {
LOG.fine("Client successfully initialised: topic=" + topic + ", connection=" + connection + ", config=" + matchingConfig);
+ // Update connection with service user credentials
+ connection.setCredentials(realm, serviceUser.getUsername(), serviceUser.getSecret());
+
synchronized (provisioningConfigAuthenticatedConnectionMap) {
provisioningConfigAuthenticatedConnectionMap.compute(matchingConfig.getId(), (id, connections) -> {
if (connections == null) {
connections = new HashSet<>();
- connections.add(connection);
}
+ connections.remove(connection);
+ connections.add(connection);
return connections;
});
- // Update connection with service user credentials
- connection.setCredentials(realm, serviceUser.getUsername(), serviceUser.getSecret());
brokerService.publishMessage(getResponseTopic(topic), new SuccessResponseMessage(realm, asset), MqttQoS.AT_MOST_ONCE);
}
}
diff --git a/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy b/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
index a260b6230..590869ffd 100644
--- a/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/provisioning/UserAndAssetProvisioningTest.groovy
@@ -19,7 +19,14 @@
*/
package org.openremote.test.provisioning
+import com.hivemq.client.internal.mqtt.mqtt3.Mqtt3AsyncClientView
+import com.hivemq.client.internal.mqtt.mqtt3.Mqtt3ClientConfigView
+import com.hivemq.client.mqtt.MqttClientConfig
+import com.hivemq.client.mqtt.MqttClientConnectionConfig
import io.moquette.BrokerConstants
+import io.netty.channel.ChannelOption
+import io.netty.channel.socket.SocketChannel
+import io.netty.channel.socket.nio.NioSocketChannel
import org.openremote.agent.protocol.mqtt.MQTTMessage
import org.openremote.agent.protocol.mqtt.MQTT_IOClient
import org.openremote.container.util.UniqueIdentifierGenerator
@@ -76,6 +83,7 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
def assetProcessingService = container.getService(AssetProcessingService.class)
def identityService = container.getService(ManagerIdentityService.class)
def managerTestSetup = container.getService(SetupService.class).getTaskOfType(ManagerTestSetup.class)
+ def userAssetProvisioningMQTTHandler = mqttBrokerService.customHandlers.find {it instanceof UserAssetProvisioningMQTTHandler} as UserAssetProvisioningMQTTHandler
def mqttHost = getString(container.getConfig(), MQTT_SERVER_LISTEN_HOST, BrokerConstants.HOST)
def mqttPort = getInteger(container.getConfig(), MQTT_SERVER_LISTEN_PORT, BrokerConstants.PORT)
@@ -124,9 +132,12 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
def device1UniqueId = "device1"
def mqttDevice1ClientId = UniqueIdentifierGenerator.generateId("device1")
List<String> subscribeFailures = []
+ List<ConnectionStatus> connectionStatuses = []
Consumer<String> subscribeFailureCallback = {String topic -> subscribeFailures.add(topic)}
MQTT_IOClient device1Client = new MQTT_IOClient(mqttDevice1ClientId, mqttHost, mqttPort, false, false, null, null)
device1Client.setTopicSubscribeFailureConsumer(subscribeFailureCallback)
+ device1Client.addConnectionStatusConsumer({connectionStatus ->
+ connectionStatuses.add(connectionStatus)})
device1Client.connect()
then: "mqtt connection should exist"
@@ -169,6 +180,43 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
assert asset.getAttribute("serialNumber").flatMap{it.getValue()}.orElse(null) == device1UniqueId
}
+ when: "the client gets abruptly disconnected"
+ device1Responses.clear()
+ def existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
+// ((NioSocketChannel)((MqttClientConnectionConfig)((MqttClientConfig)((Mqtt3ClientConfigView)((Mqtt3AsyncClientView)device1Client.client).clientConfig).delegate).connectionConfig.get()).channel).config().setOption(ChannelOption.SO_LINGER, 0I)
+ ((NioSocketChannel)((MqttClientConnectionConfig)((MqttClientConfig)((Mqtt3ClientConfigView)((Mqtt3AsyncClientView)device1Client.client).clientConfig).delegate).connectionConfig.get()).channel).close()
+
+ then: "the client should reconnect"
+ conditions.eventually {
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != existingConnection
+ }
+
+ then: "the subscriptions should succeed"
+ conditions.eventually {
+ assert device1Client.topicConsumerMap.get(device1ResponseTopic) != null
+ assert device1Client.topicConsumerMap.get(device1ResponseTopic).size() == 1
+ assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
+ }
+
+ when: "the client publishes a valid x509 certificate that has been signed by the CA stored in the provisioning config"
+ device1Client.sendMessage(
+ new MQTTMessage<String>(device1RequestTopic, ValueUtil.asJSON(
+ new X509ProvisioningMessage(getClass().getResource("/org/openremote/test/provisioning/device1.pem").text)
+ ).orElse(null))
+ )
+
+ then: "the broker should have published to the response topic a success message containing the provisioned asset"
+ conditions.eventually {
+ assert device1Responses.size() == 1
+ assert device1Responses.get(0) instanceof SuccessResponseMessage
+ assert ((SuccessResponseMessage)device1Responses.get(0)).realm == managerTestSetup.realmBuildingTenant
+ def asset = ((SuccessResponseMessage)device1Responses.get(0)).asset
+ assert asset != null
+ assert asset instanceof WeatherAsset
+ assert asset.getAttribute("serialNumber").flatMap{it.getValue()}.orElse(null) == device1UniqueId
+ }
+
when: "the client then subscribes to attribute events for the generated asset and asset events for all assets"
def asset = ((SuccessResponseMessage)device1Responses.get(0)).asset
def assetSubscriptionTopic = "$provisioningConfig.realm/$mqttDevice1ClientId/$DefaultMQTTHandler.ASSET_TOPIC/#".toString()
@@ -293,6 +341,12 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
assert asset.getAttribute("serialNumber").flatMap{it.getValue()}.orElse(null) == device1UniqueId
}
+ and: "the connection should be recorded against the provisioning config"
+ conditions.eventually {
+ assert userAssetProvisioningMQTTHandler.provisioningConfigAuthenticatedConnectionMap.get(provisioningConfig.id) != null
+ assert userAssetProvisioningMQTTHandler.provisioningConfigAuthenticatedConnectionMap.get(provisioningConfig.id).size() == 1
+ }
+
when: "the client subscribes again to the asset and attributes"
device1Client.addMessageConsumer(assetSubscriptionTopic, eventConsumer)
device1Client.addMessageConsumer(attributeSubscriptionTopic, eventConsumer)
@@ -457,13 +511,17 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
}
when: "the provisioning config is updated to disabled"
- def existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
+ existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
device1Responses.clear()
+ connectionStatuses.clear()
provisioningConfig.setDisabled(true)
provisioningConfig = provisioningService.merge(provisioningConfig)
then: "already connected client that was authenticated should be disconnected, then reconnect and should fail to re-subscribe to asset and attribute events"
conditions.eventually {
+ assert connectionStatuses.size() == 2
+ assert connectionStatuses.get(0) == ConnectionStatus.WAITING
+ assert connectionStatuses.get(1) == ConnectionStatus.CONNECTED
assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != existingConnection
assert !clientEventService.eventSubscriptions.sessionSubscriptionIdMap.containsKey(mqttDevice1ClientId)
@@ -528,18 +586,10 @@ class UserAndAssetProvisioningTest extends Specification implements ManagerConta
}
when: "the provisioning config is updated to enabled"
- existingConnection = mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId)
provisioningConfig.setDisabled(false)
provisioningConfig = provisioningService.merge(provisioningConfig)
- then: "already connected client that was authenticated should be disconnected, then reconnect"
- conditions.eventually {
- assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != null
- assert mqttBrokerService.clientIdConnectionMap.get(mqttDevice1ClientId) != existingConnection
- assert !clientEventService.eventSubscriptions.sessionSubscriptionIdMap.containsKey(mqttDevice1ClientId)
- }
-
- when: "the re-connected device publishes its' valid client certificate"
+ and: "the already connected device publishes its' valid client certificate"
device1Responses.clear()
device1Client.sendMessage(
new MQTTMessage<String>(device1RequestTopic, ValueUtil.asJSON(