100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
MQTT agent wildcard subscriptions support for multiple attributes with same topic (#2015)
Rich Turnereb0c8f9bc1a8
diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.javaindex 08ec29fc8..9ef6084a6 100644--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/MQTTProtocol.java@@ -48,7 +48,7 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTAprivate static final Logger LOG = SyslogCategory.getLogger(PROTOCOL, MQTTProtocol.class);public static final String PROTOCOL_DISPLAY_NAME = "MQTT Client";protected final Map<AttributeRef, Consumer<MQTTMessage<String>>> protocolMessageConsumers = new HashMap<>();- protected final Map<String, Map<String, Consumer<MQTTMessage<String>>>> wildcardTopicConsumerMap = new HashMap<>();+ protected final Map<String, Map<String, Map<AttributeRef, Consumer<MQTTMessage<String>>>>> wildcardTopicConsumerMap = new HashMap<>();protected final Set<Topic> wildcardTopics = new HashSet<>();protected KeyStoreService keyStoreService;@@ -60,6 +60,7 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTAprotected void doLinkAttribute(String assetId, Attribute<?> attribute, MQTTAgentLink agentLink) throws RuntimeException {agentLink.getSubscriptionTopic().ifPresent(topicStr -> {+ AttributeRef attributeRef = new AttributeRef(assetId, attribute.getName());Topic topic = Topic.parse(topicStr);Topic matchedWildcardTopic = findMatchingWildcardTopic(topic);@@ -75,7 +76,7 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTA};if (matchedWildcardTopic != null) {- addWildcardMessageConsumer(matchedWildcardTopic.toString(), topicStr, Optional.of(agentLink.getQos().orElse(agent.getSubscribeQoS().orElse(0))).map(qos -> qos > 2 || qos < 0 ? null : qos).map(MqttQos::fromCode).orElse(MqttQos.AT_MOST_ONCE), messageConsumer);+ addWildcardMessageConsumer(matchedWildcardTopic.toString(), topicStr, attributeRef, Optional.of(agentLink.getQos().orElse(agent.getSubscribeQoS().orElse(0))).map(qos -> qos > 2 || qos < 0 ? null : qos).map(MqttQos::fromCode).orElse(MqttQos.AT_MOST_ONCE), messageConsumer);} else {client.addMessageConsumer(topicStr, Optional.of(agentLink.getQos().orElse(agent.getSubscribeQoS().orElse(0))).map(qos -> qos > 2 || qos < 0 ? null : qos).map(MqttQos::fromCode).orElse(MqttQos.AT_MOST_ONCE), messageConsumer);protocolMessageConsumers.put(new AttributeRef(assetId, attribute.getName()), messageConsumer);@@ -116,7 +117,7 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTA} else {Topic topic = Topic.parse(topicStr);Optional.ofNullable(findMatchingWildcardTopic(topic)).ifPresent(wildcardTopic ->- removeWildcardMessageConsumer(wildcardTopic.toString(), topicStr)+ removeWildcardMessageConsumer(wildcardTopic.toString(), topicStr, attributeRef));}});@@ -197,38 +198,43 @@ public class MQTTProtocol extends AbstractMQTTClientProtocol<MQTTProtocol, MQTTAreturn "MQTT Client";}- protected void addWildcardMessageConsumer(String wildcardTopic, String topic, MqttQos qos, Consumer<MQTTMessage<String>> messageConsumer) {- LOG.fine("Adding wildcard message consumer uri=" + client.getClientUri() + ", topic=" + wildcardTopic);+ protected void addWildcardMessageConsumer(String wildcardTopic, String topic, AttributeRef attributeRef, MqttQos qos, Consumer<MQTTMessage<String>> messageConsumer) {+ LOG.fine("Adding wildcard message consumer uri=" + client.getClientUri() + ", wildcardTopic=" + wildcardTopic + ", topic=" + topic + ", " + attributeRef);synchronized (wildcardTopicConsumerMap) {wildcardTopicConsumerMap.compute(wildcardTopic,- (t, subConsumers) -> {+ (wt, subConsumers) -> {if (subConsumers == null) {subConsumers = new ConcurrentHashMap<>();- Map<String, Consumer<MQTTMessage<String>>> finalSubConsumers = subConsumers;+ Map<String, Map<AttributeRef, Consumer<MQTTMessage<String>>>> finalSubConsumers = subConsumers;client.addMessageConsumer(wildcardTopic, qos, msg ->Optional.ofNullable(finalSubConsumers.get(msg.getTopic()))- .ifPresent(consumer -> consumer.accept(msg)));+ .ifPresent(consumers -> consumers.values().forEach(consumer -> consumer.accept(msg))));}- subConsumers.put(topic, messageConsumer);+ subConsumers.computeIfAbsent(topic, t -> new ConcurrentHashMap<>()).put(attributeRef, messageConsumer);return subConsumers;});}}- protected void removeWildcardMessageConsumer(String wildcardTopic, String topic) {- LOG.fine("Removing wildcard message consumer uri=" + client.getClientUri() + ", topic=" + wildcardTopic);+ protected void removeWildcardMessageConsumer(String wildcardTopic, String topic, AttributeRef attributeRef) {+ LOG.fine("Removing wildcard message consumer uri=" + client.getClientUri() + ", wildcardTopic=" + wildcardTopic + ", topic=" + topic + ", " + attributeRef);synchronized (wildcardTopicConsumerMap) {wildcardTopicConsumerMap.computeIfPresent(wildcardTopic,- (t, subConsumers) -> {- if (subConsumers.remove(topic) != null && subConsumers.isEmpty()) {- client.removeMessageConsumers(wildcardTopic);+ (wt, wildcardTopicConsumers) -> {+ wildcardTopicConsumers.computeIfPresent(topic, (t, attributeRefConsumerMap) -> {+ attributeRefConsumerMap.remove(attributeRef);+ return attributeRefConsumerMap.isEmpty() ? null : attributeRefConsumerMap;+ });+ if (wildcardTopicConsumers.isEmpty()) {+ // No more consumers for the wildcard topic+ client.removeMessageConsumers(wt);return null;}- return subConsumers;+ return wildcardTopicConsumers;});}}diff --git a/test/src/test/groovy/org/openremote/test/protocol/mqtt/MQTTClientProtocolTest.groovy b/test/src/test/groovy/org/openremote/test/protocol/mqtt/MQTTClientProtocolTest.groovyindex 97f28f9a3..81895631a 100644--- a/test/src/test/groovy/org/openremote/test/protocol/mqtt/MQTTClientProtocolTest.groovy+++ b/test/src/test/groovy/org/openremote/test/protocol/mqtt/MQTTClientProtocolTest.groovy@@ -607,6 +607,11 @@ class MQTTClientProtocolTest extends Specification implements ManagerContainerTrnew MetaItem<>(AGENT_LINK, new MQTTAgentLink(agent.id).setSubscriptionTopic(humidityTopic))),+ new Attribute<>("humidity2", NUMBER)+ .addMeta(+ new MetaItem<>(AGENT_LINK, new MQTTAgentLink(agent.id)+ .setSubscriptionTopic(humidityTopic)+ )),new Attribute<>("pressure", NUMBER).addMeta(new MetaItem<>(AGENT_LINK, new MQTTAgentLink(agent.id)@@ -632,9 +637,12 @@ class MQTTClientProtocolTest extends Specification implements ManagerContainerTrassert protocol.wildcardTopicConsumerMap.size() == 2assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).size() == 2assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).containsKey(temperatureTopic)+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).get(temperatureTopic).size() == 1assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).containsKey(humidityTopic)+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).get(humidityTopic).size() == 2assert protocol.wildcardTopicConsumerMap.get(wildcardTopic2).size() == 1assert protocol.wildcardTopicConsumerMap.get(wildcardTopic2).containsKey(pressureTopic)+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic2).get(pressureTopic).size() == 1}when: "mqtt data is published"@@ -654,9 +662,53 @@ class MQTTClientProtocolTest extends Specification implements ManagerContainerTrasset = assetStorageService.find(asset.id, true)assert asset.getAttribute("temperature").flatMap { it.value }.map { it == 19.5 }.orElse(false)assert asset.getAttribute("humidity").flatMap { it.value }.map { it == 85 }.orElse(false)+ assert asset.getAttribute("humidity2").flatMap { it.value }.map { it == 85 }.orElse(false)assert asset.getAttribute("pressure").flatMap { it.value }.map { it == 1013.25 }.orElse(false)assert asset.getAttribute("uvIndex").flatMap { it.value }.map { it == 3.0 }.orElse(false)}++ when: "an attribute is removed that uses the wildcard subscription"+ asset.attributes.remove("humidity2")+ asset = assetStorageService.merge(asset)++ then: "the wildcard subscription should still exist as another attribute still matches it"+ conditions.eventually {+ def protocol = (MQTTProtocol)agentService.getProtocolInstance(agent.id)+ def client = protocol.@client+ assert client.topicConsumerMap.containsKey(wildcardTopic1)+ assert client.topicConsumerMap.containsKey(wildcardTopic2)+ assert client.topicConsumerMap.containsKey(uvIndexTopic)+ assert protocol.wildcardTopicConsumerMap.size() == 2+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).size() == 2+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).containsKey(temperatureTopic)+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).get(temperatureTopic).size() == 1+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).containsKey(humidityTopic)+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic1).get(humidityTopic).size() == 1+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic2).size() == 1+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic2).containsKey(pressureTopic)+ assert protocol.wildcardTopicConsumerMap.get(wildcardTopic2).get(pressureTopic).size() == 1+ }++ when: "mqtt data is published"+ attributeEvent = new AttributeEvent(testThing1.id, "temperature", 20.5)+ assetProcessingService.sendAttributeEvent(attributeEvent)+ attributeEvent = new AttributeEvent(testThing1.id, "humidity", 90.0)+ assetProcessingService.sendAttributeEvent(attributeEvent)++ attributeEvent = new AttributeEvent(testThing2.id, "pressure", 1000)+ assetProcessingService.sendAttributeEvent(attributeEvent)++ attributeEvent = new AttributeEvent(testThing3.id, "uvIndex", 4.0)+ assetProcessingService.sendAttributeEvent(attributeEvent)++ then: "asset attribute values should be updated"+ conditions.eventually {+ asset = assetStorageService.find(asset.id, true)+ assert asset.getAttribute("temperature").flatMap { it.value }.map { it == 20.5 }.orElse(false)+ assert asset.getAttribute("humidity").flatMap { it.value }.map { it == 90 }.orElse(false)+ assert asset.getAttribute("pressure").flatMap { it.value }.map { it == 1000 }.orElse(false)+ assert asset.getAttribute("uvIndex").flatMap { it.value }.map { it == 4.0 }.orElse(false)+ }}/**