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
Added support for outputting triggered asset info in JSON rule email action
Rich Turner36ba11935452
diff --git a/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java b/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.javaindex 3f9bf770e..0bd32712e 100644--- a/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java+++ b/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java@@ -27,6 +27,7 @@ import org.openremote.manager.concurrent.ManagerExecutorService;import org.openremote.manager.rules.facade.NotificationsFacade;import org.openremote.model.asset.Asset;import org.openremote.model.attribute.AttributeRef;+import org.openremote.model.notification.EmailNotificationMessage;import org.openremote.model.notification.Notification;import org.openremote.model.query.AssetQuery;import org.openremote.model.query.LogicGroup;@@ -35,6 +36,7 @@ import org.openremote.model.query.filter.AttributePredicate;import org.openremote.model.query.filter.DateTimePredicate;import org.openremote.model.rules.AssetState;import org.openremote.model.rules.Assets;+import org.openremote.model.rules.Ruleset;import org.openremote.model.rules.Users;import org.openremote.model.rules.json.*;import org.openremote.model.util.Pair;@@ -48,6 +50,7 @@ import java.util.function.BiConsumer;import java.util.function.Predicate;import java.util.logging.Level;import java.util.stream.Collectors;+import java.util.stream.IntStream;import java.util.stream.Stream;import static org.openremote.container.util.Util.distinctByKey;@@ -411,6 +414,9 @@ public class JsonRulesBuilder extends RulesBuilder {USER}+ public static final String PLACEHOLDER_RULESET_ID = "%RULESET_ID%";+ public static final String PLACEHOLDER_RULESET_NAME = "%RULESET_NAME%";+ public static final String PLACEHOLDER_TRIGGER_ASSETS = "%TRIGGER_ASSETS%";final static String LOG_PREFIX = "JSON Rules: ";final protected AssetStorageService assetStorageService;final protected TimerService timerService;@@ -422,7 +428,7 @@ public class JsonRulesBuilder extends RulesBuilder {final protected Map<String, RuleEvaluationResult> ruleEvaluationMap = new HashMap<>();final protected JsonRule[] jsonRules;- public JsonRulesBuilder(JsonRule[] jsonRules, TimerService timerService, AssetStorageService assetStorageService, ManagerExecutorService executorService, Assets assetsFacade, Users usersFacade, NotificationsFacade notificationsFacade, BiConsumer<Runnable, Long> scheduledActionConsumer) {+ public JsonRulesBuilder(Ruleset ruleset, TimerService timerService, AssetStorageService assetStorageService, ManagerExecutorService executorService, Assets assetsFacade, Users usersFacade, NotificationsFacade notificationsFacade, BiConsumer<Runnable, Long> scheduledActionConsumer) throws Exception {this.timerService = timerService;this.assetStorageService = assetStorageService;this.executorService = executorService;@@ -430,8 +436,18 @@ public class JsonRulesBuilder extends RulesBuilder {this.usersFacade = usersFacade;this.notificationsFacade = notificationsFacade;this.scheduledActionConsumer = scheduledActionConsumer;- this.jsonRules = jsonRules;+ String rulesStr = ruleset.getRules();+ rulesStr = rulesStr.replace(PLACEHOLDER_RULESET_ID, Long.toString(ruleset.getId()));+ rulesStr = rulesStr.replace(PLACEHOLDER_RULESET_NAME, ruleset.getName());++ JsonRulesetDefinition jsonRulesetDefinition = Container.JSON.readValue(rulesStr, JsonRulesetDefinition.class);++ if (jsonRulesetDefinition == null || jsonRulesetDefinition.rules == null || jsonRulesetDefinition.rules.length == 0) {+ throw new IllegalArgumentException("No rules within ruleset so nothing to start: " + ruleset);+ }++ this.jsonRules = jsonRulesetDefinition.rules;Arrays.stream(jsonRules).forEach(this::add);}@@ -646,6 +662,27 @@ public class JsonRulesBuilder extends RulesBuilder {if (notificationAction.notification != null) {+ if (notificationAction.notification.getMessage() != null && Objects.equals(notificationAction.notification.getMessage().getType(), EmailNotificationMessage.TYPE)) {+ EmailNotificationMessage email = (EmailNotificationMessage)notificationAction.notification.getMessage();++ boolean hasBody = !TextUtil.isNullOrEmpty(email.getHtml()) || !TextUtil.isNullOrEmpty(email.getText());+ boolean isHtml = !TextUtil.isNullOrEmpty(email.getHtml());++ if (hasBody) {+ String body = isHtml ? email.getHtml() : email.getText();++ if (body.contains(PLACEHOLDER_TRIGGER_ASSETS)) {+ String triggeredAssetInfo = buildTriggeredAssetInfo(useUnmatched, triggerStateMap, isHtml);+ body = body.replace(PLACEHOLDER_TRIGGER_ASSETS, triggeredAssetInfo);+ if (isHtml) {+ email.setHtml(body);+ } else {+ email.setText(body);+ }+ }+ }+ }+// Override the notification targets if set in the ruleNotification.TargetType targetType = targetIsNotAssets(ruleAction.target) ? Notification.TargetType.USER : Notification.TargetType.ASSET;Collection<String> ids = getRuleActionTargetIds(ruleAction.target, useUnmatched, triggerStateMap, assetsFacade, usersFacade, facts);@@ -818,6 +855,46 @@ public class JsonRulesBuilder extends RulesBuilder {return null;}+ private static String buildTriggeredAssetInfo(boolean useUnmatched, Map<String, RuleTriggerState> triggerStateMap, boolean isHtml) {+ List<AssetState> assetStates = triggerStateMap.values().stream().flatMap(ruleTriggerState -> {+ Collection<AssetState> as = useUnmatched+ ? ruleTriggerState.lastTriggerResult.unmatchedAssetStates+ : ruleTriggerState.lastTriggerResult.matchedAssetStates;+ return as.stream();+ }).collect(Collectors.toList());++ StringBuilder sb = new StringBuilder();+ if (isHtml) {+ sb.append("<table>");+ sb.append("<tr><th>Asset ID</th><th>Asset Name</th><th>Attribute</th><th>Value</th></tr>");+ assetStates.forEach(assetState -> {+ sb.append("<tr><td>");+ sb.append(assetState.getId());+ sb.append("</td><td>");+ sb.append(assetState.getName());+ sb.append("</td><td>");+ sb.append(assetState.getAttributeName());+ sb.append("</td><td>");+ sb.append(assetState.getValue().map(Value::toString).orElse(""));+ sb.append("</td></tr>");+ });+ sb.append("</table>");+ } else {+ sb.append("Asset ID\tAsset Name\tAttribute\tValue");+ assetStates.forEach(assetState -> {+ sb.append(assetState.getId());+ sb.append("\t");+ sb.append(assetState.getName());+ sb.append("\t");+ sb.append(assetState.getAttributeName());+ sb.append("\t");+ sb.append(assetState.getValue().map(Value::toString).orElse(""));+ });+ }++ return sb.toString();+ }+protected static Collection<String> getRuleActionTargetIds(RuleActionTarget target, boolean useUnmatched, Map<String, RuleTriggerState> triggerStateMap, Assets assetsFacade, Users usersFacade, RulesFacts facts) {if (target != null) {if (!TextUtil.isNullOrEmpty(target.ruleConditionTag) && triggerStateMap != null) {diff --git a/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java b/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.javaindex 9adff7743..73127f5f3 100644--- a/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java+++ b/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java@@ -260,17 +260,7 @@ public class RulesetDeployment {protected boolean compileRulesJson(Ruleset ruleset) {try {- String rulesStr = ruleset.getRules();- rulesStr = rulesStr.replace("%RULESET_ID%", Long.toString(ruleset.getId()));- rulesStr = rulesStr.replace("%RULESET_NAME%", ruleset.getName());-- JsonRulesetDefinition jsonRulesetDefinition = Container.JSON.readValue(rulesStr, JsonRulesetDefinition.class);-- if (jsonRulesetDefinition == null || jsonRulesetDefinition.rules == null || jsonRulesetDefinition.rules.length == 0) {- throw new IllegalArgumentException("No rules within ruleset so nothing to start: " + ruleset);- }-- jsonRulesBuilder = new JsonRulesBuilder(jsonRulesetDefinition.rules, timerService, assetStorageService, executorService, assetsFacade, usersFacade, notificationsFacade, this::scheduleRuleAction);+ jsonRulesBuilder = new JsonRulesBuilder(ruleset, timerService, assetStorageService, executorService, assetsFacade, usersFacade, notificationsFacade, this::scheduleRuleAction);for (Rule rule : jsonRulesBuilder.build()) {RulesEngine.LOG.fine("Registering JSON rule: " + rule.getName());@@ -282,7 +272,6 @@ public class RulesetDeployment {setError(e);return false;}-}protected boolean compileRulesJavascript(Ruleset ruleset, Assets assetsFacade, Users usersFacade, NotificationsFacade consolesFacade) {diff --git a/model/src/main/java/org/openremote/model/notification/Notification.java b/model/src/main/java/org/openremote/model/notification/Notification.javaindex 10b9620e3..32447e6dc 100644--- a/model/src/main/java/org/openremote/model/notification/Notification.java+++ b/model/src/main/java/org/openremote/model/notification/Notification.java@@ -69,7 +69,7 @@ public class Notification {public String toString() {return getClass().getSimpleName()+ "{" +"type=" + type +- "id=" + id ++ ", id=" + id +'}';}}diff --git a/test/src/test/groovy/org/openremote/test/rules/residence/JsonRulesTest.groovy b/test/src/test/groovy/org/openremote/test/rules/residence/JsonRulesTest.groovyindex d2d865515..8d3052f92 100644--- a/test/src/test/groovy/org/openremote/test/rules/residence/JsonRulesTest.groovy+++ b/test/src/test/groovy/org/openremote/test/rules/residence/JsonRulesTest.groovy@@ -83,7 +83,7 @@ class JsonRulesTest extends Specification implements ManagerContainerTrait {// Assume sent to FCMsendMessage(_ as Email) >> {email ->- emailMessages << email+ emailMessages << email.get(0)return NotificationSendResult.success()}}@@ -221,11 +221,12 @@ class JsonRulesTest extends Specification implements ManagerContainerTrait {assert targets[0].id == consoleRegistration.id}- and: "an email should have been sent to [email protected]"+ and: "an email should have been sent to [email protected] with the triggered asset in the body"conditions.eventually {assert emailMessages.size() == 1assert emailMessages[0].recipients.size() == 1- assert emailMessages[0].recipients[0].address[0] == "[email protected]"+ assert emailMessages[0].recipients[0].address == "[email protected]"+ assert emailMessages[0].HTMLText == "<table><tr><th>Asset ID</th><th>Asset Name</th><th>Attribute</th><th>Value</th></tr><tr><td>${consoleRegistration.id}</td><td>Test Console</td><td>location</td><td>{\"type\":\"Point\",\"coordinates\":[0,0]}</td></tr></table>"}and: "after a few seconds the rule should not have fired again"diff --git a/test/src/test/resources/org/openremote/test/rules/BasicJsonRules.json b/test/src/test/resources/org/openremote/test/rules/BasicJsonRules.jsonindex 24b55aeac..c6e914cdd 100644--- a/test/src/test/resources/org/openremote/test/rules/BasicJsonRules.json+++ b/test/src/test/resources/org/openremote/test/rules/BasicJsonRules.json@@ -61,7 +61,7 @@"message": {"type": "email","subject": "%RULESET_NAME%",- "html": "TEST",+ "html": "%TRIGGER_ASSETS%","to": [{"address": "[email protected]",