From f723c3c847d06eeeb1c4ba75b0526d99b940c008 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 12 Aug 2022 13:00:39 +0300 Subject: [PATCH] add options fromMetadata change logic node --- ...omMdToMsgNode.java => TbCopyKeysNode.java} | 80 ++++++++++++------- ....java => TbCopyKeysNodeConfiguration.java} | 12 +-- ...gNodeTest.java => TbCopyKeysNodeTest.java} | 45 ++++++++--- 3 files changed, 91 insertions(+), 46 deletions(-) rename rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/{TbCopyFromMdToMsgNode.java => TbCopyKeysNode.java} (52%) rename rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/{TbCopyFromMdToMsgNodeConfiguration.java => TbCopyKeysNodeConfiguration.java} (67%) rename rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/{TbCopyFromMdToMsgNodeTest.java => TbCopyKeysNodeTest.java} (72%) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java similarity index 52% rename from rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNode.java rename to rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index 2d82951c42..180a10146d 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -32,59 +32,77 @@ import org.thingsboard.server.common.msg.TbMsg; import org.thingsboard.server.common.msg.TbMsgMetaData; import java.util.List; +import java.util.Map; import java.util.concurrent.ExecutionException; +import java.util.regex.Pattern; @Slf4j @RuleNode( type = ComponentType.TRANSFORMATION, - name = "copy from metadata to msg", - configClazz = TbCopyFromMdToMsgNodeConfiguration.class, - nodeDescription = "Copies the msg metadata keys to msg data with specified key names selected in the list", - nodeDetails = "Will fetch fields values specified in list. If specified field is not part of msg metadata fields it will be ignored." + + name = "copy keys", + configClazz = TbCopyKeysNodeConfiguration.class, + nodeDescription = "Copies the msg or metadata keys with specified key names selected in the list", + nodeDetails = "Will fetch fields values specified in list. If specified field is not part of msg or metadata fields it will be ignored." + "If the msg is not a JSON object returns the incoming message as outbound message with Failure chain, " + "otherwise returns transformed messages via Success chain", uiResources = {"static/rulenode/rulenode-core-config.js"}, - configDirective = "tbTransformationNodeCopyFromMdToMsgConfig", - icon = "functions" + configDirective = "tbTransformationNodeCopyKeysConfig", + icon = "content_copy" ) -public class TbCopyFromMdToMsgNode implements TbNode { +public class TbCopyKeysNode implements TbNode { - TbCopyFromMdToMsgNodeConfiguration config; + TbCopyKeysNodeConfiguration config; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { - this.config = TbNodeUtils.convert(configuration, TbCopyFromMdToMsgNodeConfiguration.class); + this.config = TbNodeUtils.convert(configuration, TbCopyKeysNodeConfiguration.class); } @Override public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { - processCopy(ctx, msg); + List keys = config.getKeys(); + if (CollectionUtils.isEmpty(keys)) { + ctx.tellSuccess(msg); + } else { + TbMsgMetaData metaData = msg.getMetaData(); + String msgData = msg.getData(); + JsonNode dataNode = JacksonUtil.toJsonNode(msgData); + if (!dataNode.isObject()) { + ctx.tellFailure(msg, new RuntimeException("Msg data is not a JSON Object!")); + return; + } + if (config.isFromMetadata()) { + ObjectNode msgDataNode = (ObjectNode) dataNode; + Map metaDataMap = metaData.getData(); + keys.forEach(key -> { + Pattern pattern = Pattern.compile(key); + metaDataMap.forEach((keyMetaData, valueMetaData) -> { + if (pattern.matcher(keyMetaData).matches()) { + if (!StringUtils.isEmpty(valueMetaData)) { + msgDataNode.put(keyMetaData, valueMetaData); + } + } + }); + }); + msgData = JacksonUtil.toString(msgDataNode); + } else { + keys.forEach(key -> { + Pattern pattern = Pattern.compile(key); + dataNode.fields().forEachRemaining(entry -> { + String keyData = entry.getKey(); + if (pattern.matcher(keyData).matches()) { + metaData.putValue(keyData, String.valueOf(entry.getValue())); + } + }); + }); + } + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); + } } @Override public void destroy() { - } - private void processCopy(TbContext ctx, TbMsg msg) { - List metadataMsgKeys = config.getMetadataMsgKeys(); - if (CollectionUtils.isEmpty(metadataMsgKeys)) { - ctx.tellSuccess(msg); - } else { - JsonNode dataNode = JacksonUtil.toJsonNode(msg.getData()); - if (dataNode.isObject()) { - ObjectNode msgData = (ObjectNode) dataNode; - TbMsgMetaData metaData = msg.getMetaData(); - metadataMsgKeys.forEach(metadataKey -> { - String value = metaData.getValue(metadataKey); - if (!StringUtils.isEmpty(value)) { - msgData.put(metadataKey, value); - } - }); - ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, JacksonUtil.toString(msgData))); - } else { - ctx.tellFailure(msg, new RuntimeException("Msg data is not a JSON Object!")); - } - } } } diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeConfiguration.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java similarity index 67% rename from rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeConfiguration.java rename to rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java index fdcdb5f1b6..5e747fdd30 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeConfiguration.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java @@ -22,14 +22,16 @@ import java.util.Collections; import java.util.List; @Data -public class TbCopyFromMdToMsgNodeConfiguration implements NodeConfiguration { +public class TbCopyKeysNodeConfiguration implements NodeConfiguration { - private List metadataMsgKeys; + private boolean fromMetadata; + private List keys; @Override - public TbCopyFromMdToMsgNodeConfiguration defaultConfiguration() { - TbCopyFromMdToMsgNodeConfiguration configuration = new TbCopyFromMdToMsgNodeConfiguration(); - configuration.setMetadataMsgKeys(Collections.emptyList()); + public TbCopyKeysNodeConfiguration defaultConfiguration() { + TbCopyKeysNodeConfiguration configuration = new TbCopyKeysNodeConfiguration(); + configuration.setKeys(Collections.emptyList()); + configuration.setFromMetadata(false); return configuration; } diff --git a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java similarity index 72% rename from rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java rename to rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java index 50609edaa0..774136e660 100644 --- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java @@ -44,12 +44,12 @@ import static org.mockito.Mockito.spy; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; -public class TbCopyFromMdToMsgNodeTest { +public class TbCopyKeysNodeTest { final ObjectMapper mapper = new ObjectMapper(); DeviceId deviceId; - TbCopyFromMdToMsgNode node; - TbCopyFromMdToMsgNodeConfiguration config; + TbCopyKeysNode node; + TbCopyKeysNodeConfiguration config; TbNodeConfiguration nodeConfiguration; TbContext ctx; TbMsgCallback callback; @@ -59,10 +59,11 @@ public class TbCopyFromMdToMsgNodeTest { deviceId = new DeviceId(UUID.randomUUID()); callback = mock(TbMsgCallback.class); ctx = mock(TbContext.class); - config = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); - config.setMetadataMsgKeys(List.of("TestKey_1", "TestKey_2", "TestKey_3")); + config = new TbCopyKeysNodeConfiguration().defaultConfiguration(); + config.setKeys(List.of("TestKey_1", "TestKey_2", "TestKey_3", "(\\w*)Data(\\w*)")); + config.setFromMetadata(true); nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); - node = spy(new TbCopyFromMdToMsgNode()); + node = spy(new TbCopyKeysNode()); node.init(ctx, nodeConfiguration); } @@ -78,12 +79,13 @@ public class TbCopyFromMdToMsgNodeTest { @Test void givenDefaultConfig_whenVerify_thenOK() { - TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); - assertThat(defaultConfig.getMetadataMsgKeys()).isEqualTo(Collections.emptyList()); + TbCopyKeysNodeConfiguration defaultConfig = new TbCopyKeysNodeConfiguration().defaultConfiguration(); + assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptyList()); + assertThat(defaultConfig.isFromMetadata()).isEqualTo(false); } @Test - void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception { + void givenMsgFromMetadata_whenOnMsg_thenVerifyOutput() throws Exception { String data = "{}"; node.onMsg(ctx, getTbMsg(deviceId, data)); @@ -96,11 +98,33 @@ public class TbCopyFromMdToMsgNodeTest { JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData()); assertThat(dataNode.has("TestKey_1")).isEqualTo(true); + assertThat(dataNode.has("voltageDataValue")).isEqualTo(true); + } + + @Test + void givenMsgFromMsg_whenOnMsg_thenVerifyOutput() throws Exception { + config.setFromMetadata(false); + nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); + node.init(ctx, nodeConfiguration); + + String data = "{\"DigitData\":22.5,\"TempDataValue\":10.5}"; + node.onMsg(ctx, getTbMsg(deviceId, data)); + + ArgumentCaptor newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); + verify(ctx, times(1)).tellSuccess(newMsgCaptor.capture()); + verify(ctx, never()).tellFailure(any(), any()); + + TbMsg newMsg = newMsgCaptor.getValue(); + assertThat(newMsg).isNotNull(); + + Map metaDataMap = newMsg.getMetaData().getData(); + assertThat(metaDataMap.containsKey("DigitData")).isEqualTo(true); + assertThat(metaDataMap.containsKey("TempDataValue")).isEqualTo(true); } @Test void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception { - TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); + TbCopyKeysNodeConfiguration defaultConfig = new TbCopyKeysNodeConfiguration().defaultConfiguration(); nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); node.init(ctx, nodeConfiguration); @@ -134,6 +158,7 @@ public class TbCopyFromMdToMsgNodeTest { final Map mdMap = Map.of( "TestKey_1", "Test", "country", "US", + "voltageDataValue", "220", "city", "NY" ); return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback);