Volodymyr Babak
4 years ago
7 changed files with 367 additions and 163 deletions
@ -0,0 +1,177 @@ |
|||
/** |
|||
* 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.edge; |
|||
|
|||
import com.fasterxml.jackson.core.type.TypeReference; |
|||
import com.fasterxml.jackson.databind.JsonNode; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
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.DataConstants; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.StringUtils; |
|||
import org.thingsboard.server.common.data.edge.EdgeEventActionType; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.common.msg.TbMsg; |
|||
import org.thingsboard.server.common.msg.session.SessionMsgType; |
|||
|
|||
import java.util.HashMap; |
|||
import java.util.List; |
|||
import java.util.Map; |
|||
import java.util.UUID; |
|||
|
|||
@Slf4j |
|||
public abstract class AbstractTbMsgPushNode<T extends BaseTbMsgPushNodeConfiguration, S, U> implements TbNode { |
|||
|
|||
protected T config; |
|||
|
|||
private static final String SCOPE = "scope"; |
|||
|
|||
@Override |
|||
public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { |
|||
this.config = TbNodeUtils.convert(configuration, getConfigClazz()); |
|||
} |
|||
|
|||
@Override |
|||
public void onMsg(TbContext ctx, TbMsg msg) { |
|||
if (getIgnoredMessageSource().equalsIgnoreCase(msg.getMetaData().getValue(DataConstants.MSG_SOURCE_KEY))) { |
|||
log.debug("Ignoring msg from the {}, msg [{}]", getIgnoredMessageSource(), msg); |
|||
ctx.ack(msg); |
|||
return; |
|||
} |
|||
if (isSupportedOriginator(msg.getOriginator().getEntityType())) { |
|||
if (isSupportedMsgType(msg.getType())) { |
|||
processMsg(ctx, msg); |
|||
} else { |
|||
String errMsg = String.format("Unsupported msg type %s", msg.getType()); |
|||
log.debug(errMsg); |
|||
ctx.tellFailure(msg, new RuntimeException(errMsg)); |
|||
} |
|||
} else { |
|||
String errMsg = String.format("Unsupported originator type %s", msg.getOriginator().getEntityType()); |
|||
log.debug(errMsg); |
|||
ctx.tellFailure(msg, new RuntimeException(errMsg)); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public void destroy() { |
|||
} |
|||
|
|||
protected S buildEvent(TbMsg msg, TbContext ctx) { |
|||
String msgType = msg.getType(); |
|||
if (DataConstants.ALARM.equals(msgType)) { |
|||
return buildEvent(ctx.getTenantId(), EdgeEventActionType.ADDED, getUUIDFromMsgData(msg), getAlarmEventType(), null); |
|||
} else { |
|||
U eventTypeByEntityType = getEventTypeByEntityType(msg.getOriginator().getEntityType()); |
|||
if (eventTypeByEntityType == null) { |
|||
return null; |
|||
} |
|||
EdgeEventActionType actionType = getEdgeEventActionTypeByMsgType(msgType); |
|||
Map<String, Object> entityBody = new HashMap<>(); |
|||
Map<String, String> metadata = msg.getMetaData().getData(); |
|||
JsonNode dataJson = JacksonUtil.toJsonNode(msg.getData()); |
|||
switch (actionType) { |
|||
case ATTRIBUTES_UPDATED: |
|||
case POST_ATTRIBUTES: |
|||
entityBody.put("kv", dataJson); |
|||
entityBody.put(SCOPE, getScope(metadata)); |
|||
if (SessionMsgType.POST_ATTRIBUTES_REQUEST.name().equals(msgType)) { |
|||
entityBody.put("isPostAttributes", true); |
|||
} |
|||
break; |
|||
case ATTRIBUTES_DELETED: |
|||
List<String> keys = JacksonUtil.convertValue(dataJson.get("attributes"), new TypeReference<>() {}); |
|||
entityBody.put("keys", keys); |
|||
entityBody.put(SCOPE, getScope(metadata)); |
|||
break; |
|||
case TIMESERIES_UPDATED: |
|||
entityBody.put("data", dataJson); |
|||
entityBody.put("ts", metadata.get("ts")); |
|||
break; |
|||
} |
|||
return buildEvent(ctx.getTenantId(), actionType, msg.getOriginator().getId(), eventTypeByEntityType, JacksonUtil.valueToTree(entityBody)); |
|||
} |
|||
} |
|||
|
|||
abstract S buildEvent(TenantId tenantId, EdgeEventActionType edgeEventAction, UUID entityId, U edgeEventType, JsonNode entityBody); |
|||
|
|||
abstract U getEventTypeByEntityType(EntityType entityType); |
|||
|
|||
abstract U getAlarmEventType(); |
|||
|
|||
abstract String getIgnoredMessageSource(); |
|||
|
|||
abstract protected Class<T> getConfigClazz(); |
|||
|
|||
abstract void processMsg(TbContext ctx, TbMsg msg); |
|||
|
|||
protected UUID getUUIDFromMsgData(TbMsg msg) { |
|||
JsonNode data = JacksonUtil.toJsonNode(msg.getData()).get("id"); |
|||
String id = JacksonUtil.convertValue(data.get("id"), String.class); |
|||
return UUID.fromString(id); |
|||
} |
|||
|
|||
protected String getScope(Map<String, String> metadata) { |
|||
String scope = metadata.get(SCOPE); |
|||
if (StringUtils.isEmpty(scope)) { |
|||
scope = config.getScope(); |
|||
} |
|||
return scope; |
|||
} |
|||
|
|||
protected EdgeEventActionType getEdgeEventActionTypeByMsgType(String msgType) { |
|||
EdgeEventActionType actionType; |
|||
if (SessionMsgType.POST_TELEMETRY_REQUEST.name().equals(msgType)) { |
|||
actionType = EdgeEventActionType.TIMESERIES_UPDATED; |
|||
} else if (DataConstants.ATTRIBUTES_UPDATED.equals(msgType)) { |
|||
actionType = EdgeEventActionType.ATTRIBUTES_UPDATED; |
|||
} else if (SessionMsgType.POST_ATTRIBUTES_REQUEST.name().equals(msgType)) { |
|||
actionType = EdgeEventActionType.POST_ATTRIBUTES; |
|||
} else { |
|||
actionType = EdgeEventActionType.ATTRIBUTES_DELETED; |
|||
} |
|||
return actionType; |
|||
} |
|||
|
|||
protected boolean isSupportedMsgType(String msgType) { |
|||
return SessionMsgType.POST_TELEMETRY_REQUEST.name().equals(msgType) |
|||
|| SessionMsgType.POST_ATTRIBUTES_REQUEST.name().equals(msgType) |
|||
|| DataConstants.ATTRIBUTES_UPDATED.equals(msgType) |
|||
|| DataConstants.ATTRIBUTES_DELETED.equals(msgType) |
|||
|| DataConstants.TIMESERIES_UPDATED.equals(msgType) |
|||
|| DataConstants.ALARM.equals(msgType); |
|||
} |
|||
|
|||
protected boolean isSupportedOriginator(EntityType entityType) { |
|||
switch (entityType) { |
|||
case DEVICE: |
|||
case ASSET: |
|||
case ENTITY_VIEW: |
|||
case DASHBOARD: |
|||
case TENANT: |
|||
case CUSTOMER: |
|||
case EDGE: |
|||
return true; |
|||
default: |
|||
return false; |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,33 @@ |
|||
/** |
|||
* 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.edge; |
|||
|
|||
import lombok.Data; |
|||
import org.thingsboard.rule.engine.api.NodeConfiguration; |
|||
import org.thingsboard.server.common.data.DataConstants; |
|||
|
|||
@Data |
|||
public class BaseTbMsgPushNodeConfiguration implements NodeConfiguration<BaseTbMsgPushNodeConfiguration> { |
|||
|
|||
private String scope; |
|||
|
|||
@Override |
|||
public BaseTbMsgPushNodeConfiguration defaultConfiguration() { |
|||
BaseTbMsgPushNodeConfiguration configuration = new BaseTbMsgPushNodeConfiguration(); |
|||
configuration.setScope(DataConstants.SERVER_SCOPE); |
|||
return configuration; |
|||
} |
|||
} |
|||
@ -0,0 +1,76 @@ |
|||
/** |
|||
* 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.edge; |
|||
|
|||
import org.junit.Before; |
|||
import org.junit.Test; |
|||
import org.junit.runner.RunWith; |
|||
import org.mockito.Mock; |
|||
import org.mockito.Mockito; |
|||
import org.mockito.junit.MockitoJUnitRunner; |
|||
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.TenantId; |
|||
import org.thingsboard.server.common.data.page.PageData; |
|||
import org.thingsboard.server.common.data.page.PageLink; |
|||
import org.thingsboard.server.common.msg.TbMsg; |
|||
import org.thingsboard.server.common.msg.TbMsgDataType; |
|||
import org.thingsboard.server.common.msg.TbMsgMetaData; |
|||
import org.thingsboard.server.common.msg.session.SessionMsgType; |
|||
import org.thingsboard.server.dao.edge.EdgeService; |
|||
|
|||
import java.util.UUID; |
|||
|
|||
import static org.mockito.Mockito.verify; |
|||
|
|||
@RunWith(MockitoJUnitRunner.class) |
|||
public class TbMsgPushToEdgeNodeTest { |
|||
|
|||
TbMsgPushToEdgeNode node; |
|||
|
|||
private final TenantId tenantId = TenantId.fromUUID(UUID.randomUUID()); |
|||
private final DeviceId deviceId = new DeviceId(UUID.randomUUID()); |
|||
|
|||
@Mock |
|||
private TbContext ctx; |
|||
|
|||
@Mock |
|||
private EdgeService edgeService; |
|||
|
|||
@Before |
|||
public void setUp() throws TbNodeException { |
|||
node = new TbMsgPushToEdgeNode(); |
|||
TbMsgPushToEdgeNodeConfiguration config = new TbMsgPushToEdgeNodeConfiguration().defaultConfiguration(); |
|||
node.init(ctx, new TbNodeConfiguration(JacksonUtil.valueToTree(config))); |
|||
} |
|||
|
|||
@Test |
|||
public void ackMsgInCaseNoEdgeRelated() { |
|||
Mockito.when(ctx.getTenantId()).thenReturn(tenantId); |
|||
Mockito.when(ctx.getEdgeService()).thenReturn(edgeService); |
|||
Mockito.when(edgeService.findRelatedEdgeIdsByEntityId(tenantId, deviceId, new PageLink(TbMsgPushToEdgeNode.DEFAULT_PAGE_SIZE))).thenReturn(new PageData<>()); |
|||
|
|||
TbMsg msg = TbMsg.newMsg(SessionMsgType.POST_TELEMETRY_REQUEST.name(), deviceId, new TbMsgMetaData(), |
|||
TbMsgDataType.JSON, "{}", null, null); |
|||
|
|||
node.onMsg(ctx, msg); |
|||
|
|||
verify(ctx).ack(msg); |
|||
} |
|||
} |
|||
Loading…
Reference in new issue