From 14b924c0dff1c3c26ef178e36bd22efff4987ddd Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 12 Aug 2022 14:48:02 +0300 Subject: [PATCH 1/6] new RuleNode "delete keys" --- .../engine/transform/TbDeleteKeysNode.java | 108 +++++++++++++ .../TbDeleteKeysNodeConfiguration.java | 41 +++++ .../transform/TbDeleteKeysNodeTest.java | 153 ++++++++++++++++++ 3 files changed, 302 insertions(+) create mode 100644 rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java create mode 100644 rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java create mode 100644 rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java new file mode 100644 index 0000000000..7ec7450929 --- /dev/null +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java @@ -0,0 +1,108 @@ +/** + * 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.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.concurrent.ExecutionException; +import java.util.regex.Pattern; + +@Slf4j +@RuleNode( + type = ComponentType.TRANSFORMATION, + name = "delete keys", + configClazz = TbDeleteKeysNodeConfiguration.class, + nodeDescription = "Removes keys from the msg data or metadata with the specified key names selected in the list", + nodeDetails = "Will fetch fields (regex) values specified in list. If specified field (regex) is not part of msg " + + "or metadata fields it will be ignored. Returns transformed messages via Success chain", + uiResources = {"static/rulenode/rulenode-core-config.js"}, + configDirective = "tbTransformationNodeDeleteKeysConfig", + icon = "remove_circle" +) +public class TbDeleteKeysNode implements TbNode { + + TbDeleteKeysNodeConfiguration config; + + @Override + public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { + this.config = TbNodeUtils.convert(configuration, TbDeleteKeysNodeConfiguration.class); + } + + @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(); + if (config.isFromMetadata()) { + Map metaDataMap = metaData.getData(); + List keysToDelete = new ArrayList<>(); + keys.forEach(key -> { + Pattern pattern = Pattern.compile(key); + metaDataMap.forEach((keyMetaData, valueMetaData) -> { + if (pattern.matcher(keyMetaData).matches()) { + keysToDelete.add(keyMetaData); + } + }); + }); + keysToDelete.forEach(key -> metaDataMap.remove(key)); + metaData = new TbMsgMetaData(metaDataMap); + } else { + JsonNode dataNode = JacksonUtil.toJsonNode(msgData); + if (dataNode.isObject()) { + List keysToDelete = new ArrayList<>(); + ObjectNode msgDataObject = (ObjectNode) dataNode; + keys.forEach(key -> { + Pattern pattern = Pattern.compile(key); + msgDataObject.fields().forEachRemaining(entry -> { + String keyData = entry.getKey(); + if (pattern.matcher(keyData).matches()) { + keysToDelete.add(keyData); + } + }); + }); + msgDataObject.remove(keysToDelete); + msgData = JacksonUtil.toString(msgDataObject); + } + } + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); + } + } + + @Override + public void destroy() { + + } +} + diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java new file mode 100644 index 0000000000..87b6d622ce --- /dev/null +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java @@ -0,0 +1,41 @@ +/** + * 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 TbDeleteKeysNodeConfiguration implements NodeConfiguration { + + private boolean fromMetadata; + private List keys; + + @Override + public TbDeleteKeysNodeConfiguration defaultConfiguration() { + TbDeleteKeysNodeConfiguration configuration = new TbDeleteKeysNodeConfiguration(); + 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/TbDeleteKeysNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java new file mode 100644 index 0000000000..1f62150016 --- /dev/null +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java @@ -0,0 +1,153 @@ +/** + * 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 TbDeleteKeysNodeTest { + final ObjectMapper mapper = new ObjectMapper(); + + DeviceId deviceId; + TbDeleteKeysNode node; + TbDeleteKeysNodeConfiguration 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 TbDeleteKeysNodeConfiguration().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 TbDeleteKeysNode()); + node.init(ctx, nodeConfiguration); + } + + @AfterEach + void tearDown() { + node.destroy(); + } + + @Test + void givenDefaultConfig_whenInit_thenOK() { + assertThat(node.config).isEqualTo(config); + } + + @Test + void givenDefaultConfig_whenVerify_thenOK() { + TbDeleteKeysNodeConfiguration defaultConfig = new TbDeleteKeysNodeConfiguration().defaultConfiguration(); + assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptyList()); + assertThat(defaultConfig.isFromMetadata()).isEqualTo(false); + } + + @Test + void givenMsgFromMetadata_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(); + + Map metaDataMap = newMsg.getMetaData().getData(); + assertThat(metaDataMap.containsKey("DigitData")).isEqualTo(false); + assertThat(metaDataMap.containsKey("TempDataValue")).isEqualTo(false); + } + + @Test + void givenMsgFromMsg_whenOnMsg_thenVerifyOutput() throws Exception { + config.setFromMetadata(false); + nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); + node.init(ctx, nodeConfiguration); + + String data = "{\"Voltage\":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(); + + JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData()); + assertThat(dataNode.has("TempDataValue")).isEqualTo(false); + assertThat(dataNode.has("Voltage")).isEqualTo(true); + } + + @Test + void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception { + TbDeleteKeysNodeConfiguration defaultConfig = new TbDeleteKeysNodeConfiguration().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); + } + + private TbMsg getTbMsg(EntityId entityId, String data) { + 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); + } +} \ No newline at end of file From ee1d8e41890034f2490d8022e44153569ee2d3f5 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Mon, 15 Aug 2022 11:35:59 +0300 Subject: [PATCH 2/6] code review --- .../engine/transform/TbDeleteKeysNode.java | 58 +++++++++---------- .../TbDeleteKeysNodeConfiguration.java | 5 +- .../transform/TbDeleteKeysNodeTest.java | 12 ++-- 3 files changed, 36 insertions(+), 39 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java index 7ec7450929..e3d2be336a 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.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; @@ -33,6 +32,7 @@ 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.concurrent.ExecutionException; import java.util.regex.Pattern; @@ -59,45 +59,41 @@ public class TbDeleteKeysNode 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); + Set keys = config.getKeys(); + TbMsgMetaData metaData = msg.getMetaData(); + String msgData = msg.getData(); + if (config.isFromMetadata()) { + Map metaDataMap = metaData.getData(); + List keysToDelete = new ArrayList<>(); + keys.forEach(key -> { + Pattern pattern = Pattern.compile(key); + metaDataMap.forEach((keyMetaData, valueMetaData) -> { + if (pattern.matcher(keyMetaData).matches()) { + keysToDelete.add(keyMetaData); + } + }); + }); + keysToDelete.forEach(key -> metaDataMap.remove(key)); + metaData = new TbMsgMetaData(metaDataMap); } else { - TbMsgMetaData metaData = msg.getMetaData(); - String msgData = msg.getData(); - if (config.isFromMetadata()) { - Map metaDataMap = metaData.getData(); + JsonNode dataNode = JacksonUtil.toJsonNode(msgData); + if (dataNode.isObject()) { List keysToDelete = new ArrayList<>(); + ObjectNode msgDataObject = (ObjectNode) dataNode; keys.forEach(key -> { Pattern pattern = Pattern.compile(key); - metaDataMap.forEach((keyMetaData, valueMetaData) -> { - if (pattern.matcher(keyMetaData).matches()) { - keysToDelete.add(keyMetaData); + msgDataObject.fields().forEachRemaining(entry -> { + String keyData = entry.getKey(); + if (pattern.matcher(keyData).matches()) { + keysToDelete.add(keyData); } }); }); - keysToDelete.forEach(key -> metaDataMap.remove(key)); - metaData = new TbMsgMetaData(metaDataMap); - } else { - JsonNode dataNode = JacksonUtil.toJsonNode(msgData); - if (dataNode.isObject()) { - List keysToDelete = new ArrayList<>(); - ObjectNode msgDataObject = (ObjectNode) dataNode; - keys.forEach(key -> { - Pattern pattern = Pattern.compile(key); - msgDataObject.fields().forEachRemaining(entry -> { - String keyData = entry.getKey(); - if (pattern.matcher(keyData).matches()) { - keysToDelete.add(keyData); - } - }); - }); - msgDataObject.remove(keysToDelete); - msgData = JacksonUtil.toString(msgDataObject); - } + msgDataObject.remove(keysToDelete); + msgData = JacksonUtil.toString(msgDataObject); } - ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); } + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); } @Override diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java index 87b6d622ce..36c5eda7de 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java @@ -20,17 +20,18 @@ import org.thingsboard.rule.engine.api.NodeConfiguration; import java.util.Collections; import java.util.List; +import java.util.Set; @Data public class TbDeleteKeysNodeConfiguration implements NodeConfiguration { private boolean fromMetadata; - private List keys; + private Set keys; @Override public TbDeleteKeysNodeConfiguration defaultConfiguration() { TbDeleteKeysNodeConfiguration configuration = new TbDeleteKeysNodeConfiguration(); - 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/TbDeleteKeysNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java index 1f62150016..5ccf97c4c3 100644 --- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.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 TbDeleteKeysNodeTest { callback = mock(TbMsgCallback.class); ctx = mock(TbContext.class); config = new TbDeleteKeysNodeConfiguration().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 TbDeleteKeysNode()); @@ -80,7 +80,7 @@ public class TbDeleteKeysNodeTest { @Test void givenDefaultConfig_whenVerify_thenOK() { TbDeleteKeysNodeConfiguration defaultConfig = new TbDeleteKeysNodeConfiguration().defaultConfiguration(); - assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptyList()); + assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptySet()); assertThat(defaultConfig.isFromMetadata()).isEqualTo(false); } @@ -97,8 +97,8 @@ public class TbDeleteKeysNodeTest { assertThat(newMsg).isNotNull(); Map metaDataMap = newMsg.getMetaData().getData(); - assertThat(metaDataMap.containsKey("DigitData")).isEqualTo(false); - assertThat(metaDataMap.containsKey("TempDataValue")).isEqualTo(false); + assertThat(metaDataMap.containsKey("TestKey_1")).isEqualTo(false); + assertThat(metaDataMap.containsKey("voltageDataValue")).isEqualTo(false); } @Test @@ -128,7 +128,7 @@ public class TbDeleteKeysNodeTest { nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); node.init(ctx, nodeConfiguration); - String data = "{}"; + String data = "{\"Voltage\":220,\"Humidity\":56}"; node.onMsg(ctx, getTbMsg(deviceId, data)); ArgumentCaptor newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); From fbd039384a49b814b44cb1ca7349511c65820469 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 26 Aug 2022 11:44:28 +0300 Subject: [PATCH 3/6] refactor code --- .../engine/transform/TbDeleteKeysNode.java | 52 +++++++++++-------- .../TbDeleteKeysNodeConfiguration.java | 4 -- .../transform/TbDeleteKeysNodeTest.java | 4 +- 3 files changed, 33 insertions(+), 27 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java index e3d2be336a..d52728d8dc 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java @@ -32,7 +32,7 @@ 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.regex.Pattern; @@ -51,49 +51,58 @@ import java.util.regex.Pattern; public class TbDeleteKeysNode implements TbNode { TbDeleteKeysNodeConfiguration config; + List patternKeys = new ArrayList<>(); + boolean fromMetadata; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { this.config = TbNodeUtils.convert(configuration, TbDeleteKeysNodeConfiguration.class); + this.fromMetadata = config.isFromMetadata(); + 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(); - if (config.isFromMetadata()) { + List keysToDelete = new ArrayList<>(); + if (fromMetadata) { Map metaDataMap = metaData.getData(); - List keysToDelete = new ArrayList<>(); - keys.forEach(key -> { - Pattern pattern = Pattern.compile(key); - metaDataMap.forEach((keyMetaData, valueMetaData) -> { - if (pattern.matcher(keyMetaData).matches()) { - keysToDelete.add(keyMetaData); - } - }); + metaDataMap.forEach((keyMetaData, valueMetaData) -> { + if (checkKey(keyMetaData)) { + keysToDelete.add(keyMetaData); + } }); keysToDelete.forEach(key -> metaDataMap.remove(key)); metaData = new TbMsgMetaData(metaDataMap); } else { JsonNode dataNode = JacksonUtil.toJsonNode(msgData); if (dataNode.isObject()) { - List keysToDelete = new ArrayList<>(); ObjectNode msgDataObject = (ObjectNode) dataNode; - keys.forEach(key -> { - Pattern pattern = Pattern.compile(key); - msgDataObject.fields().forEachRemaining(entry -> { - String keyData = entry.getKey(); - if (pattern.matcher(keyData).matches()) { - keysToDelete.add(keyData); - } - }); + dataNode.fields().forEachRemaining(entry -> { + String keyData = entry.getKey(); + if (checkKey(keyData)) { + keysToDelete.add(keyData); + } }); msgDataObject.remove(keysToDelete); msgData = JacksonUtil.toString(msgDataObject); } } - ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); + if (keysToDelete.isEmpty()) { + ctx.tellSuccess(msg); + } else { + ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData)); + } + } + + boolean checkKey(String key) { + Optional currentPattern = patternKeys.stream() + .filter(pattern -> pattern.matcher(key).matches()) + .findFirst(); + return currentPattern.isPresent(); } @Override @@ -101,4 +110,3 @@ public class TbDeleteKeysNode implements TbNode { } } - diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java index 36c5eda7de..5666aaffca 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeConfiguration.java @@ -19,7 +19,6 @@ import lombok.Data; import org.thingsboard.rule.engine.api.NodeConfiguration; import java.util.Collections; -import java.util.List; import java.util.Set; @Data @@ -37,6 +36,3 @@ public class TbDeleteKeysNodeConfiguration implements NodeConfiguration Date: Tue, 6 Sep 2022 15:01:44 +0300 Subject: [PATCH 4/6] refactor code --- .../rule/engine/transform/TbDeleteKeysNode.java | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java index d52728d8dc..f9b79741a5 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java @@ -51,13 +51,14 @@ import java.util.regex.Pattern; public class TbDeleteKeysNode implements TbNode { TbDeleteKeysNodeConfiguration config; - List patternKeys = new ArrayList<>(); + List patternKeys; boolean fromMetadata; @Override public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { this.config = TbNodeUtils.convert(configuration, TbDeleteKeysNodeConfiguration.class); this.fromMetadata = config.isFromMetadata(); + this.patternKeys = new ArrayList<>(); config.getKeys().forEach(key -> { this.patternKeys.add(Pattern.compile(key)); }); @@ -99,10 +100,7 @@ public class TbDeleteKeysNode 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 4702d9702a60d3681846095ca596d1d33035d70b Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Fri, 23 Sep 2022 11:06:33 +0300 Subject: [PATCH 5/6] delete destroy --- .../thingsboard/rule/engine/transform/TbDeleteKeysNode.java | 5 ----- 1 file changed, 5 deletions(-) diff --git a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java index f9b79741a5..a5643cd865 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java @@ -102,9 +102,4 @@ public class TbDeleteKeysNode implements TbNode { boolean checkKey(String key) { return patternKeys.stream().anyMatch(pattern -> pattern.matcher(key).matches()); } - - @Override - public void destroy() { - - } } From 29044eb3249757e32aebc649f74ad79ded422711 Mon Sep 17 00:00:00 2001 From: Yuriy Lytvynchuk Date: Tue, 27 Sep 2022 13:01:58 +0300 Subject: [PATCH 6/6] private fields in node --- .../thingsboard/rule/engine/transform/TbDeleteKeysNode.java | 6 +++--- .../rule/engine/transform/TbDeleteKeysNodeTest.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/TbDeleteKeysNode.java b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java index a5643cd865..dfe3b05846 100644 --- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java +++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNode.java @@ -50,9 +50,9 @@ import java.util.regex.Pattern; ) public class TbDeleteKeysNode implements TbNode { - TbDeleteKeysNodeConfiguration config; - List patternKeys; - boolean fromMetadata; + private TbDeleteKeysNodeConfiguration 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/TbDeleteKeysNodeTest.java b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java index b6c40b8992..988864610e 100644 --- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java +++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbDeleteKeysNodeTest.java @@ -72,12 +72,6 @@ public class TbDeleteKeysNodeTest { 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() { TbDeleteKeysNodeConfiguration defaultConfig = new TbDeleteKeysNodeConfiguration().defaultConfiguration();