new RuleNode 'split array msg'

4 years ago · 0fc4071d3e
2 changed files with 221 additions and 0 deletions
--- a/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbSplitArrayMsgNode.java
+++ b/rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbSplitArrayMsgNode.java
@ -0,0 +1,85 @@
+/**
+ * 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.ArrayNode;
+import lombok.extern.slf4j.Slf4j;
+import org.thingsboard.common.util.JacksonUtil;
+import org.thingsboard.rule.engine.api.EmptyNodeConfiguration;
+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 java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+
+@Slf4j
+@RuleNode(
+        type = ComponentType.EXTERNAL,
+        name = "split array msg",
+        configClazz = EmptyNodeConfiguration.class,
+        nodeDescription = "Split array message into several msgs",
+        nodeDetails = "",
+        icon = "functions",
+        configDirective = "tbNodeEmptyConfig"
+)
+public class TbSplitArrayMsgNode implements TbNode {
+
+    EmptyNodeConfiguration config;
+
+    @Override
+    public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException {
+        this.config = TbNodeUtils.convert(configuration, EmptyNodeConfiguration.class);
+    }
+
+    @Override
+    public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException {
+        JsonNode jsonNode = JacksonUtil.toJsonNode(msg.getData());
+        if (jsonNode.isArray()) {
+            ArrayNode data = (ArrayNode) jsonNode;
+            List<TbMsg> messages = new ArrayList<>();
+            data.forEach(msgNode -> {
+                messages.add(createNewMsg(msg, msgNode));
+            });
+            ctx.ack(msg);
+            if (messages.size() == 1) {
+                ctx.tellSuccess(messages.get(0));
+            } else {
+                for (TbMsg newMsg : messages) {
+                    ctx.tellSuccess(newMsg);
+                }
+            }
+        } else {
+            ctx.tellSuccess(msg);
+        }
+    }
+
+    private TbMsg createNewMsg(TbMsg msg, JsonNode msgNode) {
+        return TbMsg.newMsg(msg.getQueueName(), msg.getType(), msg.getOriginator(), msg.getMetaData(), JacksonUtil.toString(msgNode));
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+}
--- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbSplitArrayMsgNodeTest.java
+++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbSplitArrayMsgNodeTest.java
@ -0,0 +1,136 @@
+/**
+ * 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 com.fasterxml.jackson.databind.node.ArrayNode;
+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.EmptyNodeConfiguration;
+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.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 TbSplitArrayMsgNodeTest {
+    final ObjectMapper mapper = new ObjectMapper();
+
+    DeviceId deviceId;
+    TbSplitArrayMsgNode node;
+    EmptyNodeConfiguration 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 EmptyNodeConfiguration();
+        nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
+        node = spy(new TbSplitArrayMsgNode());
+        node.init(ctx, nodeConfiguration);
+    }
+
+    @AfterEach
+    void tearDown() {
+        node.destroy();
+    }
+
+    @Test
+    void givenDefaultConfig_whenInit_thenOK() {
+        assertThat(node.config).isEqualTo(config);
+    }
+
+    @Test
+    void givenFewMsg_whenOnMsg_thenVerifyOutput() throws Exception {
+        String data = "[{\"Attribute_1\":22.5,\"Attribute_2\":10.3}, {\"Attribute_1\":1,\"Attribute_2\":2}]";
+        VerifyOutputMsg(data);
+    }
+
+    @Test
+    void givenOneMsg_whenOnMsg_thenVerifyOutput() throws Exception {
+        String data = "[{\"Attribute_1\":22.5,\"Attribute_2\":10.3}]";
+        VerifyOutputMsg(data);
+    }
+
+    @Test
+    void givenZeroMsg_whenOnMsg_thenVerifyOutput() throws Exception {
+        String data = "[]";
+        VerifyOutputMsg(data);
+    }
+
+    @Test
+    void givenNoArrayMsg_whenOnMsg_thenVerifyOutput() throws Exception {
+        String data = "{\"Attribute_1\":22.5,\"Attribute_2\":10.3}";
+        JsonNode dataNode = JacksonUtil.toJsonNode(data);
+        TbMsg msg = getTbMsg(deviceId, dataNode.toString());
+        node.onMsg(ctx, msg);
+
+        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).isSameAs(msg);
+    }
+
+    private void VerifyOutputMsg(String data) throws Exception {
+        ArrayNode dataNode = (ArrayNode) JacksonUtil.toJsonNode(data);
+        node.onMsg(ctx, getTbMsg(deviceId, dataNode.toString()));
+
+        ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class);
+        verify(ctx, times(dataNode.size())).tellSuccess(newMsgCaptor.capture());
+        verify(ctx, never()).tellFailure(any(), any());
+
+        if (!dataNode.isEmpty()) {
+            TbMsg newMsg = newMsgCaptor.getValue();
+            assertThat(newMsg).isNotNull();
+
+            assertThat(newMsg.getData()).isEqualTo(dataNode.get(dataNode.size() - 1).toString());
+        }
+    }
+
+    private TbMsg getTbMsg(EntityId entityId, String data) {
+        Map<String, String> mdMap = Map.of(
+                "country", "US",
+                "city", "NY"
+        );
+        return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback);
+    }
+}