From bba96e17f8146a4b33deb46ff7bafa68758c20cc Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Thu, 28 Jul 2022 16:01:53 +0300 Subject: [PATCH 01/12] new RuleNode "copy from metadata to msg" --- .../transform/TbCopyFromMdToMsgNodeTest.java | 141 ++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java 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 new file mode 100644 index 0000000000..50609edaa0 --- /dev/null +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java @@ -0,0 +1,141 @@ +/** + * Copyright © 2016-2022 The Thingsboard Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +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; +import org.mockito.ArgumentCaptor; +import org.thingsboard.common.util.JacksonUtil; +import org.thingsboard.rule.engine.api.TbContext; +import org.thingsboard.rule.engine.api.TbNodeConfiguration; +import org.thingsboard.rule.engine.api.TbNodeException; +import org.thingsboard.server.common.data.id.DeviceId; +import org.thingsboard.server.common.data.id.EntityId; +import org.thingsboard.server.common.msg.TbMsg; +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; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.spy; +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; + TbNodeConfiguration nodeConfiguration; + TbContext ctx; + TbMsgCallback callback; + + @BeforeEach + void setUp() throws TbNodeException { + 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()); + node.init(ctx, nodeConfiguration); + } + + @AfterEach + void tearDown() { + node.destroy(); + } + + @Test + void givenDefaultConfig_whenInit_thenOK() { + assertThat(node.config).isEqualTo(config); + } + + @Test + void givenDefaultConfig_whenVerify_thenOK() { + TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); + assertThat(defaultConfig.getMetadataMsgKeys()).isEqualTo(Collections.emptyList()); + } + + @Test + void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception { + String data = "{}"; + 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(); + + JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData()); + assertThat(dataNode.has("TestKey_1")).isEqualTo(true); + } + + @Test + void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception { + TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); + nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); + node.init(ctx, nodeConfiguration); + + String data = "{}"; + 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(); + + assertThat(newMsg.getData()).isEqualTo(data); + } + + @Test + void givenMsgDataNotJSONObject_whenOnMsg_thenTellFailure() throws Exception { + String data = "[]"; + node.onMsg(ctx, getTbMsg(deviceId, data)); + + ArgumentCaptor newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); + ArgumentCaptor exceptionCaptor = ArgumentCaptor.forClass(Exception.class); + verify(ctx, never()).tellSuccess(any()); + verify(ctx, times(1)).tellFailure(newMsgCaptor.capture(), exceptionCaptor.capture()); + + assertThat(exceptionCaptor.getValue()).isInstanceOf(RuntimeException.class); + } + + private TbMsg getTbMsg(EntityId entityId, String data) { + final Map mdMap = Map.of( + "TestKey_1", "Test", + "country", "US", + "city", "NY" + ); + return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback); + } +} \ No newline at end of file From 0cb849002772c89b56b002d3f1a54082269db3db Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Thu, 28 Jul 2022 16:02:04 +0300 Subject: [PATCH 02/12] new RuleNode "copy from metadata to msg" --- .../transform/TbCopyFromMdToMsgNode.java | 88 +++++++++++++++++++ .../TbCopyFromMdToMsgNodeConfiguration.java | 39 ++++++++ 2 files changed, 127 insertions(+) create mode 100644 rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNode.java create mode 100644 rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeConfiguration.java 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/TbCopyFromMdToMsgNode.java new file mode 100644 index 0000000000..b01a99e50f --- /dev/null +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNode.java @@ -0,0 +1,88 @@ +/** + * Copyright © 2016-2022 The Thingsboard Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.rule.engine.transform; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import lombok.extern.slf4j.Slf4j; +import org.springframework.util.CollectionUtils; +import org.thingsboard.common.util.JacksonUtil; +import org.thingsboard.rule.engine.api.RuleNode; +import org.thingsboard.rule.engine.api.TbContext; +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.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 = "", + uiResources = {"static/rulenode/rulenode-core-config.js"}, + configDirective = "", + icon = "functions" +) +public class TbCopyFromMdToMsgNode implements TbNode { + + TbCopyFromMdToMsgNodeConfiguration config; + + @Override + public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { + this.config = TbNodeUtils.convert(configuration, TbCopyFromMdToMsgNodeConfiguration.class); + } + + @Override + public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { + processCopy(ctx, msg); + } + + @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/TbCopyFromMdToMsgNodeConfiguration.java new file mode 100644 index 0000000000..fdcdb5f1b6 --- /dev/null +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeConfiguration.java @@ -0,0 +1,39 @@ +/** + * Copyright © 2016-2022 The Thingsboard Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.rule.engine.transform; + +import lombok.Data; +import org.thingsboard.rule.engine.api.NodeConfiguration; + +import java.util.Collections; +import java.util.List; + +@Data +public class TbCopyFromMdToMsgNodeConfiguration implements NodeConfiguration { + + private List metadataMsgKeys; + + @Override + public TbCopyFromMdToMsgNodeConfiguration defaultConfiguration() { + TbCopyFromMdToMsgNodeConfiguration configuration = new TbCopyFromMdToMsgNodeConfiguration(); + configuration.setMetadataMsgKeys(Collections.emptyList()); + return configuration; + } + +} + + + From 6f928c6f4bc0ab0fc323264018dd7589ba40bda0 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 29 Jul 2022 11:29:19 +0300 Subject: [PATCH 03/12] add nodeDetails --- .../rule/engine/transform/TbCopyFromMdToMsgNode.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) 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/TbCopyFromMdToMsgNode.java index b01a99e50f..bb7e58a6ac 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/TbCopyFromMdToMsgNode.java @@ -39,8 +39,10 @@ import java.util.concurrent.ExecutionException; 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 = "", + 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." + + "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" From fd9736b051158d09bd84169fe9223b5ee6b7dd62 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Tue, 2 Aug 2022 16:11:57 +0300 Subject: [PATCH 04/12] add configDirective --- .../rule/engine/transform/TbCopyFromMdToMsgNode.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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/TbCopyFromMdToMsgNode.java index bb7e58a6ac..2d82951c42 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/TbCopyFromMdToMsgNode.java @@ -44,7 +44,7 @@ import java.util.concurrent.ExecutionException; "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 = "", + configDirective = "tbTransformationNodeCopyFromMdToMsgConfig", icon = "functions" ) public class TbCopyFromMdToMsgNode implements TbNode { From f723c3c847d06eeeb1c4ba75b0526d99b940c008 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 12 Aug 2022 13:00:39 +0300 Subject: [PATCH 05/12] 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); From a1c4f5e94eb26aa1c1188ee6f30136b5b509d681 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Mon, 15 Aug 2022 12:16:27 +0300 Subject: [PATCH 06/12] code review --- .../rule/engine/transform/TbCopyKeysNode.java | 69 +++++++++---------- .../engine/transform/TbCopyKeysNodeTest.java | 7 +- 2 files changed, 35 insertions(+), 41 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index 180a10146d..a9de122bfc 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -18,7 +18,6 @@ package org.thingsboard.rule.engine.transform; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.node.ObjectNode; import lombok.extern.slf4j.Slf4j; -import org.springframework.util.CollectionUtils; import org.thingsboard.common.util.JacksonUtil; import org.thingsboard.rule.engine.api.RuleNode; import org.thingsboard.rule.engine.api.TbContext; @@ -26,7 +25,6 @@ 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; @@ -61,43 +59,38 @@ public class TbCopyKeysNode implements TbNode { @Override public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { 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)); + 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()) { + 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, JacksonUtil.toString(entry.getValue())); + } + }); + }); + } + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); } @Override diff --git a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java index 774136e660..5a7147b65d 100644 --- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java @@ -128,8 +128,9 @@ public class TbCopyKeysNodeTest { nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); node.init(ctx, nodeConfiguration); - String data = "{}"; - node.onMsg(ctx, getTbMsg(deviceId, data)); + String data = "{\"DigitData\":22.5,\"TempDataValue\":10.5}"; + TbMsg msg = getTbMsg(deviceId, data); + node.onMsg(ctx, msg); ArgumentCaptor newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); verify(ctx, times(1)).tellSuccess(newMsgCaptor.capture()); @@ -138,7 +139,7 @@ public class TbCopyKeysNodeTest { TbMsg newMsg = newMsgCaptor.getValue(); assertThat(newMsg).isNotNull(); - assertThat(newMsg.getData()).isEqualTo(data); + assertThat(newMsg.getMetaData()).isEqualTo(msg.getMetaData()); } @Test From b04160998828d97873c5e2f42867015480298077 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Mon, 15 Aug 2022 13:15:50 +0300 Subject: [PATCH 07/12] config List -> Set --- .../thingsboard/rule/engine/transform/TbCopyKeysNode.java | 4 ++-- .../rule/engine/transform/TbCopyKeysNodeConfiguration.java | 6 +++--- .../rule/engine/transform/TbCopyKeysNodeTest.java | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index a9de122bfc..4612430f50 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -29,8 +29,8 @@ 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.Set; import java.util.concurrent.ExecutionException; import java.util.regex.Pattern; @@ -58,7 +58,7 @@ public class TbCopyKeysNode implements TbNode { @Override public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { - List keys = config.getKeys(); + Set keys = config.getKeys(); TbMsgMetaData metaData = msg.getMetaData(); String msgData = msg.getData(); JsonNode dataNode = JacksonUtil.toJsonNode(msgData); diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java index 5e747fdd30..b56a181fa6 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java @@ -19,18 +19,18 @@ import lombok.Data; import org.thingsboard.rule.engine.api.NodeConfiguration; import java.util.Collections; -import java.util.List; +import java.util.Set; @Data public class TbCopyKeysNodeConfiguration implements NodeConfiguration { private boolean fromMetadata; - private List keys; + private Set keys; @Override public TbCopyKeysNodeConfiguration defaultConfiguration() { TbCopyKeysNodeConfiguration configuration = new TbCopyKeysNodeConfiguration(); - configuration.setKeys(Collections.emptyList()); + configuration.setKeys(Collections.emptySet()); configuration.setFromMetadata(false); return configuration; } diff --git a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java index 5a7147b65d..65739d6ff5 100644 --- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java @@ -32,8 +32,8 @@ 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.Set; import java.util.UUID; import static org.assertj.core.api.Assertions.assertThat; @@ -60,7 +60,7 @@ public class TbCopyKeysNodeTest { callback = mock(TbMsgCallback.class); ctx = mock(TbContext.class); config = new TbCopyKeysNodeConfiguration().defaultConfiguration(); - config.setKeys(List.of("TestKey_1", "TestKey_2", "TestKey_3", "(\\w*)Data(\\w*)")); + config.setKeys(Set.of("TestKey_1", "TestKey_2", "TestKey_3", "(\\w*)Data(\\w*)")); config.setFromMetadata(true); nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); node = spy(new TbCopyKeysNode()); @@ -80,7 +80,7 @@ public class TbCopyKeysNodeTest { @Test void givenDefaultConfig_whenVerify_thenOK() { TbCopyKeysNodeConfiguration defaultConfig = new TbCopyKeysNodeConfiguration().defaultConfiguration(); - assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptyList()); + assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptySet()); assertThat(defaultConfig.isFromMetadata()).isEqualTo(false); } From 70c6413275ae8b97ff5f04873fca94cd064a0284 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 26 Aug 2022 11:06:28 +0300 Subject: [PATCH 08/12] refactor code --- .../rule/engine/transform/TbCopyKeysNode.java | 54 +++++++++++-------- .../TbCopyKeysNodeConfiguration.java | 3 -- .../engine/transform/TbCopyKeysNodeTest.java | 19 ++++--- 3 files changed, 44 insertions(+), 32 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index 4612430f50..51a6254c0b 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -29,9 +29,12 @@ 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.ArrayList; +import java.util.List; import java.util.Map; -import java.util.Set; +import java.util.Optional; import java.util.concurrent.ExecutionException; +import java.util.concurrent.atomic.AtomicBoolean; import java.util.regex.Pattern; @Slf4j @@ -50,47 +53,55 @@ import java.util.regex.Pattern; public class TbCopyKeysNode implements TbNode { TbCopyKeysNodeConfiguration config; + List patternKeys = new ArrayList<>(); @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { this.config = TbNodeUtils.convert(configuration, TbCopyKeysNodeConfiguration.class); + config.getKeys().forEach(key -> { + this.patternKeys.add(Pattern.compile(key)); + }); } @Override public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { - Set keys = config.getKeys(); TbMsgMetaData metaData = msg.getMetaData(); String msgData = msg.getData(); + AtomicBoolean msgChanged = new AtomicBoolean(false); 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); + if (dataNode.isObject()) { + if (config.isFromMetadata()) { + ObjectNode msgDataNode = (ObjectNode) dataNode; + Map metaDataMap = metaData.getData(); metaDataMap.forEach((keyMetaData, valueMetaData) -> { - if (pattern.matcher(keyMetaData).matches()) { + if (checkKey(keyMetaData)) { + msgChanged.set(true); msgDataNode.put(keyMetaData, valueMetaData); } }); - }); - msgData = JacksonUtil.toString(msgDataNode); - } else { - keys.forEach(key -> { - Pattern pattern = Pattern.compile(key); + msgData = JacksonUtil.toString(msgDataNode); + } else { dataNode.fields().forEachRemaining(entry -> { String keyData = entry.getKey(); - if (pattern.matcher(keyData).matches()) { + if (checkKey(keyData)) { + msgChanged.set(true); metaData.putValue(keyData, JacksonUtil.toString(entry.getValue())); } }); - }); + } } - ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); + if (msgChanged.get()) { + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); + } else { + ctx.tellSuccess(msg); + } + } + + boolean checkKey(String key) { + Optional currentPattern = patternKeys.stream() + .filter(pattern -> pattern.matcher(key).matches()) + .findFirst(); + return currentPattern.isPresent(); } @Override @@ -98,4 +109,3 @@ public class TbCopyKeysNode implements TbNode { } } - diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java index b56a181fa6..69f2a81465 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java @@ -36,6 +36,3 @@ public class TbCopyKeysNodeConfiguration implements NodeConfiguration newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); - ArgumentCaptor exceptionCaptor = ArgumentCaptor.forClass(Exception.class); - verify(ctx, never()).tellSuccess(any()); - verify(ctx, times(1)).tellFailure(newMsgCaptor.capture(), exceptionCaptor.capture()); + verify(ctx, times(1)).tellSuccess(newMsgCaptor.capture()); + verify(ctx, never()).tellFailure(any(), any()); - assertThat(exceptionCaptor.getValue()).isInstanceOf(RuntimeException.class); + TbMsg newMsg = newMsgCaptor.getValue(); + assertThat(newMsg).isNotNull(); + + assertThat(newMsg).isSameAs(msg); } private TbMsg getTbMsg(EntityId entityId, String data) { @@ -164,4 +168,5 @@ public class TbCopyKeysNodeTest { ); return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback); } -} \ No newline at end of file + +} From 72f2f633a7223f539f2261f04db6920bb2ac0a63 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 26 Aug 2022 11:54:32 +0300 Subject: [PATCH 09/12] add boolean fromMetadata --- .../org/thingsboard/rule/engine/transform/TbCopyKeysNode.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index 51a6254c0b..8072f72ec6 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -54,10 +54,12 @@ public class TbCopyKeysNode implements TbNode { TbCopyKeysNodeConfiguration config; List patternKeys = new ArrayList<>(); + boolean fromMetadata; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { this.config = TbNodeUtils.convert(configuration, TbCopyKeysNodeConfiguration.class); + this.fromMetadata = config.isFromMetadata(); config.getKeys().forEach(key -> { this.patternKeys.add(Pattern.compile(key)); }); @@ -70,7 +72,7 @@ public class TbCopyKeysNode implements TbNode { AtomicBoolean msgChanged = new AtomicBoolean(false); JsonNode dataNode = JacksonUtil.toJsonNode(msgData); if (dataNode.isObject()) { - if (config.isFromMetadata()) { + if (fromMetadata) { ObjectNode msgDataNode = (ObjectNode) dataNode; Map metaDataMap = metaData.getData(); metaDataMap.forEach((keyMetaData, valueMetaData) -> { From 7e8b0d59a42c33d725bcef1a194931f7825da6a4 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Mon, 5 Sep 2022 15:05:55 +0300 Subject: [PATCH 10/12] refactor code --- .../rule/engine/transform/TbCopyKeysNode.java | 43 +++++++++---------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index 8072f72ec6..10a046d8d3 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -30,11 +30,10 @@ import org.thingsboard.server.common.msg.TbMsg; import org.thingsboard.server.common.msg.TbMsgMetaData; import java.util.ArrayList; +import java.util.Iterator; import java.util.List; import java.util.Map; -import java.util.Optional; import java.util.concurrent.ExecutionException; -import java.util.concurrent.atomic.AtomicBoolean; import java.util.regex.Pattern; @Slf4j @@ -44,8 +43,7 @@ import java.util.regex.Pattern; 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", + "Returns transformed messages via Success chain", uiResources = {"static/rulenode/rulenode-core-config.js"}, configDirective = "tbTransformationNodeCopyKeysConfig", icon = "content_copy" @@ -53,13 +51,14 @@ import java.util.regex.Pattern; public class TbCopyKeysNode implements TbNode { TbCopyKeysNodeConfiguration config; - List patternKeys = new ArrayList<>(); + List patternKeys; boolean fromMetadata; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { this.config = TbNodeUtils.convert(configuration, TbCopyKeysNodeConfiguration.class); this.fromMetadata = config.isFromMetadata(); + this.patternKeys = new ArrayList<>(); config.getKeys().forEach(key -> { this.patternKeys.add(Pattern.compile(key)); }); @@ -69,30 +68,33 @@ public class TbCopyKeysNode implements TbNode { public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { TbMsgMetaData metaData = msg.getMetaData(); String msgData = msg.getData(); - AtomicBoolean msgChanged = new AtomicBoolean(false); + boolean msgChanged = false; JsonNode dataNode = JacksonUtil.toJsonNode(msgData); if (dataNode.isObject()) { if (fromMetadata) { ObjectNode msgDataNode = (ObjectNode) dataNode; Map metaDataMap = metaData.getData(); - metaDataMap.forEach((keyMetaData, valueMetaData) -> { - if (checkKey(keyMetaData)) { - msgChanged.set(true); - msgDataNode.put(keyMetaData, valueMetaData); - } - }); - msgData = JacksonUtil.toString(msgDataNode); - } else { - dataNode.fields().forEachRemaining(entry -> { + for (Map.Entry entry : metaDataMap.entrySet()) { String keyData = entry.getKey(); if (checkKey(keyData)) { - msgChanged.set(true); + msgChanged = true; + msgDataNode.put(keyData, entry.getValue()); + } + } + msgData = JacksonUtil.toString(msgDataNode); + } else { + Iterator> iteratorNode = dataNode.fields(); + while (iteratorNode.hasNext()) { + Map.Entry entry = iteratorNode.next(); + String keyData = entry.getKey(); + if (checkKey(keyData)) { + msgChanged = true; metaData.putValue(keyData, JacksonUtil.toString(entry.getValue())); } - }); + } } } - if (msgChanged.get()) { + if (msgChanged) { ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); } else { ctx.tellSuccess(msg); @@ -100,10 +102,7 @@ public class TbCopyKeysNode implements TbNode { } boolean checkKey(String key) { - Optional currentPattern = patternKeys.stream() - .filter(pattern -> pattern.matcher(key).matches()) - .findFirst(); - return currentPattern.isPresent(); + return patternKeys.stream().anyMatch(pattern -> pattern.matcher(key).matches()); } @Override From 9b88cf242c83781c1fab083b77f1b4aab14d1545 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 23 Sep 2022 10:54:43 +0300 Subject: [PATCH 11/12] delete destroy --- .../thingsboard/rule/engine/transform/TbCopyKeysNode.java | 5 ----- 1 file changed, 5 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index 10a046d8d3..c6d173a756 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -104,9 +104,4 @@ public class TbCopyKeysNode implements TbNode { boolean checkKey(String key) { return patternKeys.stream().anyMatch(pattern -> pattern.matcher(key).matches()); } - - @Override - public void destroy() { - - } } From 7c977f5287a1a5bafe0509d435bf43d5da4eafc0 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Tue, 27 Sep 2022 12:58:58 +0300 Subject: [PATCH 12/12] set private fields in node config --- .../thingsboard/rule/engine/transform/TbCopyKeysNode.java | 6 +++--- .../rule/engine/transform/TbCopyKeysNodeTest.java | 6 ------ 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java index c6d173a756..266c19fe5b 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java @@ -50,9 +50,9 @@ import java.util.regex.Pattern; ) public class TbCopyKeysNode implements TbNode { - TbCopyKeysNodeConfiguration config; - List patternKeys; - boolean fromMetadata; + private TbCopyKeysNodeConfiguration config; + private List patternKeys; + private boolean fromMetadata; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { diff --git a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java index a43cdc0049..5b48ae419e 100644 --- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java @@ -72,12 +72,6 @@ public class TbCopyKeysNodeTest { node.destroy(); } - @Test - void givenDefaultConfig_whenInit_thenOK() { - assertThat(node.config).isEqualTo(config); - assertThat(node.patternKeys.size()).isEqualTo(config.getKeys().size()); - } - @Test void givenDefaultConfig_whenVerify_thenOK() { TbCopyKeysNodeConfiguration defaultConfig = new TbCopyKeysNodeConfiguration().defaultConfiguration();