[3.3] [PROD-806] Implement alarm condition metadata displaying (#4185)

* Implement alarm condition metadata displaying

* Refactor

common/data/src/main/java/org/thingsboard/server/common/data/DataConstants.java

@@ -33,6 +33,8 @@ public class DataConstants {
     public static final String IS_EXISTING_ALARM = "isExistingAlarm";
     public static final String IS_SEVERITY_UPDATED_ALARM = "isSeverityUpdated";
     public static final String IS_CLEARED_ALARM = "isClearedAlarm";
+    public static final String ALARM_CONDITION_REPEATS = "alarmConditionRepeats";
+    public static final String ALARM_CONDITION_DURATION = "alarmConditionDuration";
 
     public static final String[] allScopes() {
         return new String[]{CLIENT_SCOPE, SHARED_SCOPE, SERVER_SCOPE};

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/profile/AlarmState.java

@@ -20,6 +20,7 @@ import com.fasterxml.jackson.databind.node.ObjectNode;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
+import org.thingsboard.common.util.JacksonUtil;
 import org.thingsboard.rule.engine.action.TbAlarmResult;
 import org.thingsboard.rule.engine.api.TbContext;
 import org.thingsboard.rule.engine.profile.state.PersistedAlarmRuleState;
@@ -28,6 +29,7 @@ import org.thingsboard.server.common.data.DataConstants;
 import org.thingsboard.server.common.data.alarm.Alarm;
 import org.thingsboard.server.common.data.alarm.AlarmSeverity;
 import org.thingsboard.server.common.data.alarm.AlarmStatus;
+import org.thingsboard.server.common.data.device.profile.AlarmConditionSpecType;
 import org.thingsboard.server.common.data.device.profile.AlarmConditionKeyType;
 import org.thingsboard.server.common.data.device.profile.DeviceProfileAlarm;
 import org.thingsboard.server.common.data.id.EntityId;
@@ -36,7 +38,6 @@ import org.thingsboard.server.common.data.query.KeyFilter;
 import org.thingsboard.server.common.msg.TbMsg;
 import org.thingsboard.server.common.msg.TbMsgMetaData;
 import org.thingsboard.server.common.msg.queue.ServiceQueue;
-import org.thingsboard.common.util.JacksonUtil;
 
 import java.util.ArrayList;
 import java.util.Comparator;
@@ -101,7 +102,7 @@ class AlarmState {
         if (resultState != null) {
             TbAlarmResult result = calculateAlarmResult(ctx, resultState);
             if (result != null) {
-                pushMsg(ctx, result);
+                pushMsg(ctx, result, resultState);
             }
             stateUpdate = clearAlarmState(stateUpdate, clearState);
         } else if (currentAlarm != null && clearState != null) {
@@ -116,7 +117,7 @@ class AlarmState {
                     stateUpdate = clearAlarmState(stateUpdate, state);
                 }
                 ctx.getAlarmService().clearAlarm(ctx.getTenantId(), currentAlarm.getId(), createDetails(clearState), System.currentTimeMillis());
-                pushMsg(ctx, new TbAlarmResult(false, false, true, currentAlarm));
+                pushMsg(ctx, new TbAlarmResult(false, false, true, currentAlarm), clearState);
                 currentAlarm = null;
             } else if (AlarmEvalResult.FALSE.equals(evalResult)) {
                 stateUpdate = clearAlarmState(stateUpdate, clearState);
@@ -155,7 +156,7 @@ class AlarmState {
         }
     }
 
-    public void pushMsg(TbContext ctx, TbAlarmResult alarmResult) {
+    public void pushMsg(TbContext ctx, TbAlarmResult alarmResult, AlarmRuleState ruleState) {
         JsonNode jsonNodes = JacksonUtil.valueToTree(alarmResult.getAlarm());
         String data = jsonNodes.toString();
         TbMsgMetaData metaData = lastMsgMetaData != null ? lastMsgMetaData.copy() : new TbMsgMetaData();
@@ -174,10 +175,20 @@ class AlarmState {
             relationType = "Alarm Cleared";
             metaData.putValue(DataConstants.IS_CLEARED_ALARM, Boolean.TRUE.toString());
         }
+        setAlarmConditionMetadata(ruleState, metaData);
         TbMsg newMsg = ctx.newMsg(lastMsgQueueName != null ? lastMsgQueueName : ServiceQueue.MAIN, "ALARM", originator, metaData, data);
         ctx.tellNext(newMsg, relationType);
     }
 
+    protected void setAlarmConditionMetadata(AlarmRuleState ruleState, TbMsgMetaData metaData) {
+        if (ruleState.getSpec().getType() == AlarmConditionSpecType.REPEATING) {
+            metaData.putValue(DataConstants.ALARM_CONDITION_REPEATS, String.valueOf(ruleState.getState().getEventCount()));
+        }
+        if (ruleState.getSpec().getType() == AlarmConditionSpecType.DURATION) {
+            metaData.putValue(DataConstants.ALARM_CONDITION_DURATION, String.valueOf(ruleState.getState().getDuration()));
+        }
+    }
+
     public void updateState(DeviceProfileAlarm alarm, PersistedAlarmState alarmState) {
         this.alarmDefinition = alarm;
         this.createRulesSortedBySeverityDesc = new ArrayList<>();

rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/profile/AlarmStateTest.java

@@ -0,0 +1,87 @@
+/**
+ * Copyright © 2016-2021 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.profile;
+
+import org.junit.Test;
+import org.thingsboard.server.common.data.DataConstants;
+import org.thingsboard.server.common.data.device.profile.AlarmCondition;
+import org.thingsboard.server.common.data.device.profile.AlarmConditionSpec;
+import org.thingsboard.server.common.data.device.profile.AlarmConditionSpecType;
+import org.thingsboard.server.common.data.device.profile.AlarmRule;
+import org.thingsboard.server.common.data.device.profile.DeviceProfileAlarm;
+import org.thingsboard.server.common.data.device.profile.DurationAlarmConditionSpec;
+import org.thingsboard.server.common.data.device.profile.RepeatingAlarmConditionSpec;
+import org.thingsboard.server.common.msg.TbMsgMetaData;
+
+import java.util.concurrent.TimeUnit;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.mock;
+
+public class AlarmStateTest {
+
+    @Test
+    public void testSetAlarmConditionMetadata_repeatingCondition() {
+        AlarmRuleState ruleState = createMockAlarmRuleState(new RepeatingAlarmConditionSpec());
+        int eventCount = 3;
+        ruleState.getState().setEventCount(eventCount);
+
+        AlarmState alarmState = createMockAlarmState();
+        TbMsgMetaData metaData = new TbMsgMetaData();
+
+        alarmState.setAlarmConditionMetadata(ruleState, metaData);
+
+        assertEquals(AlarmConditionSpecType.REPEATING, ruleState.getSpec().getType());
+        assertNotNull(metaData.getValue(DataConstants.ALARM_CONDITION_REPEATS));
+        assertNull(metaData.getValue(DataConstants.ALARM_CONDITION_DURATION));
+        assertEquals(String.valueOf(eventCount), metaData.getValue(DataConstants.ALARM_CONDITION_REPEATS));
+    }
+
+    @Test
+    public void testSetAlarmConditionMetadata_durationCondition() {
+        DurationAlarmConditionSpec spec = new DurationAlarmConditionSpec();
+        spec.setUnit(TimeUnit.SECONDS);
+        AlarmRuleState ruleState = createMockAlarmRuleState(spec);
+        int duration = 12;
+        ruleState.getState().setDuration(duration);
+
+        AlarmState alarmState = createMockAlarmState();
+        TbMsgMetaData metaData = new TbMsgMetaData();
+
+        alarmState.setAlarmConditionMetadata(ruleState, metaData);
+
+        assertEquals(AlarmConditionSpecType.DURATION, ruleState.getSpec().getType());
+        assertNotNull(metaData.getValue(DataConstants.ALARM_CONDITION_DURATION));
+        assertNull(metaData.getValue(DataConstants.ALARM_CONDITION_REPEATS));
+        assertEquals(String.valueOf(duration), metaData.getValue(DataConstants.ALARM_CONDITION_DURATION));
+    }
+
+    private AlarmRuleState createMockAlarmRuleState(AlarmConditionSpec spec) {
+        AlarmCondition alarmCondition = new AlarmCondition();
+        alarmCondition.setSpec(spec);
+
+        AlarmRule alarmRule = new AlarmRule();
+        alarmRule.setCondition(alarmCondition);
+
+        return new AlarmRuleState(null, alarmRule, null, null, null);
+    }
+
+    private AlarmState createMockAlarmState() {
+        return new AlarmState(null, null, mock(DeviceProfileAlarm.class), null, null);
+    }
+}