Merge pull request #10355 from irynamatveieva/improve-script-node

Changed the logic to be able to find the last IN event despite its order in the debug records.

application/src/main/java/org/thingsboard/server/controller/RuleChainController.java

@@ -47,8 +47,8 @@ import org.thingsboard.server.actors.tenant.DebugTbRateLimits;
 import org.thingsboard.server.common.data.EventInfo;
 import org.thingsboard.server.common.data.StringUtils;
 import org.thingsboard.server.common.data.edge.Edge;
-import org.thingsboard.server.common.data.event.EventType;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
+import org.thingsboard.server.common.data.id.AssetProfileId;
 import org.thingsboard.server.common.data.id.EdgeId;
 import org.thingsboard.server.common.data.id.RuleChainId;
 import org.thingsboard.server.common.data.id.RuleNodeId;
@@ -80,6 +80,7 @@ import org.thingsboard.server.service.security.permission.Resource;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.TimeUnit;
@@ -340,18 +341,8 @@ public class RuleChainController extends BaseController {
         RuleNodeId ruleNodeId = new RuleNodeId(toUUID(strRuleNodeId));
         checkRuleNode(ruleNodeId, Operation.READ);
         TenantId tenantId = getCurrentUser().getTenantId();
-        List<EventInfo> events = eventService.findLatestEvents(tenantId, ruleNodeId, EventType.DEBUG_RULE_NODE, 2);
+        return Optional.ofNullable(eventService.findLatestDebugRuleNodeInEvent(tenantId, ruleNodeId))
-        JsonNode result = null;
+                .map(EventInfo::getBody).orElse(null);
-        if (events != null) {
-            for (EventInfo event : events) {
-                JsonNode body = event.getBody();
-                if (body.has("type") && body.get("type").asText().equals("IN")) {
-                    result = body;
-                    break;
-                }
-            }
-        }
-        return result;
     }
 
     @ApiOperation(value = "Is TBEL script executor enabled",

common/dao-api/src/main/java/org/thingsboard/server/dao/event/EventService.java

@@ -35,6 +35,8 @@ public interface EventService {
 
     List<EventInfo> findLatestEvents(TenantId tenantId, EntityId entityId, EventType eventType, int limit);
 
+    EventInfo findLatestDebugRuleNodeInEvent(TenantId tenantId, EntityId entityId);
+
     PageData<EventInfo> findEventsByFilter(TenantId tenantId, EntityId entityId, EventFilter eventFilter, TimePageLink pageLink);
 
     void removeEvents(TenantId tenantId, EntityId entityId);

dao/src/main/java/org/thingsboard/server/dao/event/BaseEventService.java

@@ -37,6 +37,7 @@ import org.thingsboard.server.common.data.page.TimePageLink;
 import org.thingsboard.server.dao.service.DataValidator;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.function.BiConsumer;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -106,6 +107,11 @@ public class BaseEventService implements EventService {
         return convert(entityId.getEntityType(), eventDao.findLatestEvents(tenantId.getId(), entityId.getId(), eventType, limit));
     }
 
+    @Override
+    public EventInfo findLatestDebugRuleNodeInEvent(TenantId tenantId, EntityId entityId) {
+        return convert(entityId.getEntityType(), eventDao.findLatestDebugRuleNodeInEvent(tenantId.getId(), entityId.getId()));
+    }
+
     @Override
     public PageData<EventInfo> findEventsByFilter(TenantId tenantId, EntityId entityId, EventFilter eventFilter, TimePageLink pageLink) {
         return convert(entityId.getEntityType(), eventDao.findEventByFilter(tenantId.getId(), entityId.getId(), eventFilter, pageLink));
@@ -140,4 +146,8 @@ public class BaseEventService implements EventService {
         return list == null ? null : list.stream().map(e -> e.toInfo(entityType)).collect(Collectors.toList());
     }
 
+    private EventInfo convert(EntityType entityType, Event event) {
+        return Optional.ofNullable(event).map(e -> e.toInfo(entityType)).orElse(null);
+    }
+
 }

dao/src/main/java/org/thingsboard/server/dao/event/EventDao.java

@@ -62,6 +62,15 @@ public interface EventDao {
      */
     List<? extends Event> findLatestEvents(UUID tenantId, UUID entityId, EventType eventType, int limit);
 
+    /**
+     * Find latest debug IN event by tenantId, entityId.
+     *
+     * @param tenantId the tenantId
+     * @param entityId the entityId
+     * @return the latest debug IN event
+     */
+    Event findLatestDebugRuleNodeInEvent(UUID tenantId, UUID entityId);
+
     /**
      * Executes stored procedure to cleanup old events. Uses separate ttl for debug and other events.
      * @param regularEventExpTs the expiration time of the regular events

dao/src/main/java/org/thingsboard/server/dao/sql/event/JpaBaseEventDao.java

@@ -392,6 +392,11 @@ public class JpaBaseEventDao implements EventDao {
         return DaoUtil.convertDataList(getEventRepository(eventType).findLatestEvents(tenantId, entityId, limit));
     }
 
+    @Override
+    public Event findLatestDebugRuleNodeInEvent(UUID tenantId, UUID entityId) {
+        return DaoUtil.getData(ruleNodeDebugEventRepository.findLatestDebugRuleNodeInEvent(tenantId, entityId));
+    }
+
     @Override
     public void cleanupEvents(long regularEventExpTs, long debugEventExpTs, boolean cleanupDb) {
         if (regularEventExpTs > 0) {

dao/src/main/java/org/thingsboard/server/dao/sql/event/RuleNodeDebugEventRepository.java

@@ -26,6 +26,7 @@ import org.thingsboard.server.common.data.event.RuleNodeDebugEvent;
 import org.thingsboard.server.dao.model.sql.RuleNodeDebugEventEntity;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 
 
@@ -35,6 +36,9 @@ public interface RuleNodeDebugEventRepository extends EventRepository<RuleNodeDe
     @Query(nativeQuery = true,  value = "SELECT * FROM rule_node_debug_event e WHERE e.tenant_id = :tenantId AND e.entity_id = :entityId ORDER BY e.ts DESC LIMIT :limit")
     List<RuleNodeDebugEventEntity> findLatestEvents(@Param("tenantId") UUID tenantId, @Param("entityId") UUID entityId, @Param("limit") int limit);
 
+    @Query(nativeQuery = true,  value = "SELECT * FROM rule_node_debug_event e WHERE e.tenant_id = :tenantId AND e.entity_id = :entityId AND e.e_type = 'IN' ORDER BY e.ts DESC LIMIT 1")
+    Optional<RuleNodeDebugEventEntity> findLatestDebugRuleNodeInEvent(@Param("tenantId") UUID tenantId, @Param("entityId") UUID entityId);
+
     @Override
     @Query("SELECT e FROM RuleNodeDebugEventEntity e WHERE " +
             "e.tenantId = :tenantId " +

dao/src/test/java/org/thingsboard/server/dao/service/AbstractServiceTest.java

@@ -98,6 +98,10 @@ public abstract class AbstractServiceTest {
 
 
     protected RuleNodeDebugEvent generateEvent(TenantId tenantId, EntityId entityId) throws IOException {
+        return generateEvent(tenantId, entityId, null);
+    }
+
+    protected RuleNodeDebugEvent generateEvent(TenantId tenantId, EntityId entityId, String eventType) throws IOException {
         if (tenantId == null) {
             tenantId = TenantId.fromUUID(Uuids.timeBased());
         }
@@ -105,6 +109,7 @@ public abstract class AbstractServiceTest {
                 .tenantId(tenantId)
                 .entityId(entityId.getId())
                 .serviceId("server A")
+                .eventType(eventType)
                 .data(JacksonUtil.toString(readFromResource("TestJsonData.json")))
                 .build();
     }

dao/src/test/java/org/thingsboard/server/dao/service/event/BaseEventServiceTest.java

@@ -132,8 +132,28 @@ public abstract class BaseEventServiceTest extends AbstractServiceTest {
         eventService.cleanupEvents(timeBeforeStartTime - 1, timeAfterEndTime + 1, true);
     }
 
+    @Test
+    public void findLatestDebugRuleNodeInEvent() throws Exception {
+        CustomerId customerId = new CustomerId(Uuids.timeBased());
+        TenantId tenantId = TenantId.fromUUID(Uuids.timeBased());
+
+        Event event1 = saveEventWithProvidedTimeAndEventType(eventTime, "IN", customerId, tenantId);
+        Event event2 = saveEventWithProvidedTimeAndEventType(eventTime + 1, "IN", customerId, tenantId);
+
+        EventInfo event = eventService.findLatestDebugRuleNodeInEvent(tenantId, customerId);
+
+        Assert.assertNotNull(event);
+        Assert.assertEquals(event2.getUuidId(), event.getUuidId());
+
+        eventService.cleanupEvents(timeBeforeStartTime - 1, timeAfterEndTime + 1, true);
+    }
+
     private Event saveEventWithProvidedTime(long time, EntityId entityId, TenantId tenantId) throws Exception {
-        RuleNodeDebugEvent event = generateEvent(tenantId, entityId);
+        return saveEventWithProvidedTimeAndEventType(time, null, entityId, tenantId);
+    }
+
+    private Event saveEventWithProvidedTimeAndEventType(long time, String eventType, EntityId entityId, TenantId tenantId) throws Exception {
+        RuleNodeDebugEvent event = generateEvent(tenantId, entityId, eventType);
         event.setId(new EventId(Uuids.timeBased()));
         event.setCreatedTime(time);
         eventService.saveAsync(event).get();

dao/src/test/java/org/thingsboard/server/dao/sql/event/JpaBaseEventDaoTest.java

@@ -27,6 +27,7 @@ import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.TimePageLink;
 import org.thingsboard.server.dao.AbstractJpaDaoTest;
 import org.thingsboard.server.dao.event.EventDao;
+import org.thingsboard.server.dao.model.sql.RuleNodeDebugEventEntity;
 
 import java.util.List;
 import java.util.UUID;
@@ -42,6 +43,10 @@ public class JpaBaseEventDaoTest extends AbstractJpaDaoTest {
 
     @Autowired
     private EventDao eventDao;
+
+    @Autowired
+    private RuleNodeDebugEventRepository ruleNodeDebugEventRepository;
+
     UUID tenantId = Uuids.timeBased();
 
 
@@ -106,6 +111,23 @@ public class JpaBaseEventDaoTest extends AbstractJpaDaoTest {
 
     }
 
+    @Test
+    public void findLatestDebugRuleNodeInEvent() throws Exception {
+
+        UUID entityId = Uuids.timeBased();
+
+        RuleNodeDebugEventEntity event = getDebugInEventEntity(Uuids.timeBased(), tenantId, entityId);
+        eventDao.saveAsync(event.toData()).get(1, TimeUnit.MINUTES);
+        Thread.sleep(2);
+        RuleNodeDebugEventEntity event2 = getDebugInEventEntity(Uuids.timeBased(), tenantId, entityId);
+        eventDao.saveAsync(event2.toData()).get(1, TimeUnit.MINUTES);
+
+        RuleNodeDebugEventEntity foundEvent = ruleNodeDebugEventRepository.findLatestDebugRuleNodeInEvent(tenantId, entityId).get();
+        assertNotNull("Events expected to be not null", foundEvent);
+        assertEquals(event2.getEventType(), foundEvent.getEventType());
+        assertEquals(event2.getId(), foundEvent.getId());
+    }
+
     private Event getStatsEvent(UUID eventId, UUID tenantId, UUID entityId) {
         StatisticsEvent.StatisticsEventBuilder event = StatisticsEvent.builder();
         event.id(eventId);
@@ -117,4 +139,13 @@ public class JpaBaseEventDaoTest extends AbstractJpaDaoTest {
         event.errorsOccurred(0);
         return event.build();
     }
+
+    private RuleNodeDebugEventEntity getDebugInEventEntity(UUID eventId, UUID tenantId, UUID entityId) {
+        RuleNodeDebugEventEntity event = new RuleNodeDebugEventEntity();
+        event.setId(eventId);
+        event.setEventType("IN");
+        event.setEntityId(entityId);
+        event.setTenantId(tenantId);
+        return event;
+    }
 }