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/TbRenameMsgKeysNode.java similarity index 63% 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/TbRenameMsgKeysNode.java index b01a99e50f..f26f28b522 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/TbRenameMsgKeysNode.java @@ -26,59 +26,58 @@ import org.thingsboard.rule.engine.api.TbNode; import org.thingsboard.rule.engine.api.TbNodeConfiguration; import org.thingsboard.rule.engine.api.TbNodeException; import org.thingsboard.rule.engine.api.util.TbNodeUtils; -import org.thingsboard.server.common.data.StringUtils; import org.thingsboard.server.common.data.plugin.ComponentType; 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; @Slf4j @RuleNode( type = ComponentType.TRANSFORMATION, - name = "copy from metadata to msg", - configClazz = TbCopyFromMdToMsgNodeConfiguration.class, - nodeDescription = "Copies the message metadata keys to msg data with specified key names selected in the list", - nodeDetails = "", + name = "rename keys", + configClazz = TbRenameMsgKeysNodeConfiguration.class, + nodeDescription = "Renames the keys in the msg data to the specified key names selected in the key mapping.", + nodeDetails = "Will fetch fields values specified in mapping. If specified field is not part of msg 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 = "", icon = "functions" ) -public class TbCopyFromMdToMsgNode implements TbNode { +public class TbRenameMsgKeysNode implements TbNode { - TbCopyFromMdToMsgNodeConfiguration config; + TbRenameMsgKeysNodeConfiguration config; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { - this.config = TbNodeUtils.convert(configuration, TbCopyFromMdToMsgNodeConfiguration.class); + this.config = TbNodeUtils.convert(configuration, TbRenameMsgKeysNodeConfiguration.class); } @Override public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { - processCopy(ctx, msg); + processRename(ctx, msg); } @Override public void destroy() { } - private void processCopy(TbContext ctx, TbMsg msg) { - List metadataMsgKeys = config.getMetadataMsgKeys(); - if (CollectionUtils.isEmpty(metadataMsgKeys)) { + private void processRename(TbContext ctx, TbMsg msg) { + Map renameKeysMapping = config.getRenameKeysMapping(); + if (CollectionUtils.isEmpty(renameKeysMapping)) { 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); + renameKeysMapping.forEach((nameKey, newNameKey) -> { + if (msgData.has(nameKey)) { + msgData.set(newNameKey, msgData.get(nameKey)); + msgData.remove(nameKey); } }); - ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, JacksonUtil.toString(msgData))); + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), msg.getMetaData(), 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/TbRenameMsgKeysNodeConfiguration.java similarity index 66% 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/TbRenameMsgKeysNodeConfiguration.java index fdcdb5f1b6..0efcb38ce2 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/TbRenameMsgKeysNodeConfiguration.java @@ -19,17 +19,17 @@ import lombok.Data; import org.thingsboard.rule.engine.api.NodeConfiguration; import java.util.Collections; -import java.util.List; +import java.util.Map; @Data -public class TbCopyFromMdToMsgNodeConfiguration implements NodeConfiguration { +public class TbRenameMsgKeysNodeConfiguration implements NodeConfiguration { - private List metadataMsgKeys; + private Map renameKeysMapping; @Override - public TbCopyFromMdToMsgNodeConfiguration defaultConfiguration() { - TbCopyFromMdToMsgNodeConfiguration configuration = new TbCopyFromMdToMsgNodeConfiguration(); - configuration.setMetadataMsgKeys(Collections.emptyList()); + public TbRenameMsgKeysNodeConfiguration defaultConfiguration() { + TbRenameMsgKeysNodeConfiguration configuration = new TbRenameMsgKeysNodeConfiguration(); + configuration.setRenameKeysMapping(Collections.emptyMap()); 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/TbCopyFromMdToMsgNodeTest.java index 50609edaa0..a5995f8c90 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/TbCopyFromMdToMsgNodeTest.java @@ -16,7 +16,6 @@ package org.thingsboard.rule.engine.transform; import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.ObjectMapper; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -32,7 +31,6 @@ import org.thingsboard.server.common.msg.TbMsgMetaData; import org.thingsboard.server.common.msg.queue.TbMsgCallback; import java.util.Collections; -import java.util.List; import java.util.Map; import java.util.UUID; @@ -45,11 +43,9 @@ import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; public class TbCopyFromMdToMsgNodeTest { - final ObjectMapper mapper = new ObjectMapper(); - DeviceId deviceId; - TbCopyFromMdToMsgNode node; - TbCopyFromMdToMsgNodeConfiguration config; + TbRenameMsgKeysNode node; + TbRenameMsgKeysNodeConfiguration config; TbNodeConfiguration nodeConfiguration; TbContext ctx; TbMsgCallback callback; @@ -59,10 +55,10 @@ 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")); - nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); - node = spy(new TbCopyFromMdToMsgNode()); + config = new TbRenameMsgKeysNodeConfiguration().defaultConfiguration(); + config.setRenameKeysMapping(Map.of("TestKey_1", "Attribute_1", "TestKey_2", "Attribute_2")); + nodeConfiguration = new TbNodeConfiguration(JacksonUtil.valueToTree(config)); + node = spy(new TbRenameMsgKeysNode()); node.init(ctx, nodeConfiguration); } @@ -78,13 +74,13 @@ public class TbCopyFromMdToMsgNodeTest { @Test void givenDefaultConfig_whenVerify_thenOK() { - TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); - assertThat(defaultConfig.getMetadataMsgKeys()).isEqualTo(Collections.emptyList()); + TbRenameMsgKeysNodeConfiguration defaultConfig = new TbRenameMsgKeysNodeConfiguration().defaultConfiguration(); + assertThat(defaultConfig.getRenameKeysMapping()).isEqualTo(Collections.emptyMap()); } @Test void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception { - String data = "{}"; + String data = "{\"Temperature_1\":22.5,\"TestKey_2\":10.3}"; node.onMsg(ctx, getTbMsg(deviceId, data)); ArgumentCaptor newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); @@ -95,13 +91,14 @@ public class TbCopyFromMdToMsgNodeTest { assertThat(newMsg).isNotNull(); JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData()); - assertThat(dataNode.has("TestKey_1")).isEqualTo(true); + assertThat(dataNode.has("Attribute_2")).isEqualTo(true); + assertThat(dataNode.has("Temperature_1")).isEqualTo(true); } @Test void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception { - TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); - nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); + TbRenameMsgKeysNodeConfiguration defaultConfig = new TbRenameMsgKeysNodeConfiguration().defaultConfiguration(); + nodeConfiguration = new TbNodeConfiguration(JacksonUtil.valueToTree(defaultConfig)); node.init(ctx, nodeConfiguration); String data = "{}";