new RuleNode "delete keys"

4 years ago · 14b924c0df
3 changed files with 302 additions and 0 deletions
--- 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
@ -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 <code>Success</code> 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<String> keys = config.getKeys();
+        if (CollectionUtils.isEmpty(keys)) {
+            ctx.tellSuccess(msg);
+        } else {
+            TbMsgMetaData metaData = msg.getMetaData();
+            String msgData = msg.getData();
+            if (config.isFromMetadata()) {
+                Map<String, String> metaDataMap = metaData.getData();
+                List<String> 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<String> 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() {
+
+    }
+}
+
--- 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
@ -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<TbDeleteKeysNodeConfiguration> {
+
+    private boolean fromMetadata;
+    private List<String> keys;
+
+    @Override
+    public TbDeleteKeysNodeConfiguration defaultConfiguration() {
+        TbDeleteKeysNodeConfiguration configuration = new TbDeleteKeysNodeConfiguration();
+        configuration.setKeys(Collections.emptyList());
+        configuration.setFromMetadata(false);
+        return configuration;
+    }
+
+}
+
+
+
--- 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
@ -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<TbMsg> 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<String, String> 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<TbMsg> 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<TbMsg> 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<String, String> mdMap = Map.of(
+                "TestKey_1", "Test",
+                "country", "US",
+                "voltageDataValue", "220",
+                "city", "NY"
+        );
+        return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback);
+    }
+}