Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Prevent JSON rules from executing on engine startup (#1433)

Wouter Borncc1960a9e05e
diff --git a/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java b/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java
index 78f8e41e2..8b424d53c 100644
--- a/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java
+++ b/manager/src/main/java/org/openremote/manager/rules/JsonRulesBuilder.java
@@ -531,6 +531,7 @@ public class JsonRulesBuilder extends RulesBuilder {
final static String TIMER_TEMPORAL_FACT_NAME_PREFIX = "TimerTemporalFact-";
final static String LOG_PREFIX = "JSON Rule '";
final protected AssetStorageService assetStorageService;
+ final protected RulesEngine<?> rulesEngine;
final protected TimerService timerService;
final protected Assets assetsFacade;
final protected Users usersFacade;
@@ -546,11 +547,12 @@ public class JsonRulesBuilder extends RulesBuilder {
final protected Ruleset jsonRuleset;
protected static Logger LOG;
- public JsonRulesBuilder(Logger logger, Ruleset ruleset, TimerService timerService,
+ public JsonRulesBuilder(Logger logger, Ruleset ruleset, RulesEngine<?> rulesEngine, TimerService timerService,
AssetStorageService assetStorageService, ScheduledExecutorService executorService,
- Assets assetsFacade, Users usersFacade, Notifications notificationsFacade, Webhooks webhooksFacade,
+ Assets assetsFacade, Users usersFacade, Notifications notificationsFacade, Webhooks webhooksFacade,
Alarms alarmsFacade, HistoricDatapoints historicDatapoints, PredictedDatapoints predictedDatapoints,
BiConsumer<Runnable, Long> scheduledActionConsumer) throws Exception {
+ this.rulesEngine = rulesEngine;
this.timerService = timerService;
this.assetStorageService = assetStorageService;
this.executorService = executorService;
@@ -671,20 +673,22 @@ public class JsonRulesBuilder extends RulesBuilder {
return facts -> {
try {
- if (ruleState.thenMatched()) {
- log(Level.FINEST, "Triggered rule so executing 'then' actions for rule: " + rule.name);
- executeRuleActions(rule, rule.then, "then", false, facts, ruleState, assetsFacade, usersFacade, notificationsFacade, webhooksFacade, alarmsFacade, predictedDatapointsFacade, scheduledActionConsumer);
- }
+ // Execute actions only when the rules engine has already fired to prevent execution during startup
+ if (rulesEngine.hasPreviouslyFired()) {
+ if (ruleState.thenMatched()) {
+ log(Level.FINEST, "Triggered rule so executing 'then' actions for rule: " + rule.name);
+ executeRuleActions(rule, rule.then, "then", false, facts, ruleState, assetsFacade, usersFacade, notificationsFacade, webhooksFacade, alarmsFacade, predictedDatapointsFacade, scheduledActionConsumer);
+ }
- if (rule.otherwise != null && ruleState.otherwiseMatched()) {
- log(Level.FINEST, "Triggered rule so executing 'otherwise' actions for rule: " + rule.name);
- executeRuleActions(rule, rule.otherwise, "otherwise", true, facts, ruleState, assetsFacade, usersFacade, notificationsFacade, webhooksFacade, alarmsFacade, predictedDatapointsFacade, scheduledActionConsumer);
+ if (rule.otherwise != null && ruleState.otherwiseMatched()) {
+ log(Level.FINEST, "Triggered rule so executing 'otherwise' actions for rule: " + rule.name);
+ executeRuleActions(rule, rule.otherwise, "otherwise", true, facts, ruleState, assetsFacade, usersFacade, notificationsFacade, webhooksFacade, alarmsFacade, predictedDatapointsFacade, scheduledActionConsumer);
+ }
}
} catch (Exception e) {
log(Level.SEVERE, "Exception thrown during rule RHS execution", e);
throw e;
} finally {
-
// Store recurrence times as required
boolean recurPerAsset = rule.recurrence == null || rule.recurrence.scope != RuleRecurrence.Scope.GLOBAL;
long currentTime = timerService.getCurrentTimeMillis();
diff --git a/manager/src/main/java/org/openremote/manager/rules/RulesEngine.java b/manager/src/main/java/org/openremote/manager/rules/RulesEngine.java
index 675327a72..f32146ba2 100644
--- a/manager/src/main/java/org/openremote/manager/rules/RulesEngine.java
+++ b/manager/src/main/java/org/openremote/manager/rules/RulesEngine.java
@@ -121,6 +121,7 @@ public class RulesEngine<T extends Ruleset> {
final protected AbstractRulesEngine engine;
protected boolean running;
+ protected boolean previouslyFired;
protected long lastFireTimestamp;
protected boolean trackLocationPredicates;
protected ScheduledFuture<?> fireTimer;
@@ -147,6 +148,7 @@ public class RulesEngine<T extends Ruleset> {
MeterRegistry meterRegistry) {
this.timerService = timerService;
this.rulesService = rulesService;
+ this.previouslyFired = rulesService.startDone;
this.executorService = executorService;
this.assetStorageService = assetStorageService;
this.clientEventService = clientEventService;
@@ -275,7 +277,7 @@ public class RulesEngine<T extends Ruleset> {
removeRuleset(deployment.ruleset);
}
- deployment = new RulesetDeployment(ruleset, timerService, assetStorageService, executorService, assetsFacade, usersFacade, notificationFacade, webhooksFacade, alarmsFacade, historicFacade, predictedFacade);
+ deployment = new RulesetDeployment(ruleset, this, timerService, assetStorageService, executorService, assetsFacade, usersFacade, notificationFacade, webhooksFacade, alarmsFacade, historicFacade, predictedFacade);
deployment.init();
deployments.put(ruleset.getId(), deployment);
publishRulesetStatus(deployment);
@@ -313,7 +315,7 @@ public class RulesEngine<T extends Ruleset> {
return;
}
- if (deployments.size() == 0) {
+ if (deployments.isEmpty()) {
LOG.finest("No rulesets so nothing to start");
return;
}
@@ -511,6 +513,7 @@ public class RulesEngine<T extends Ruleset> {
// Reset facts after this firing (loop detection etc.)
facts.reset();
lastFireTimestamp = timerService.getCurrentTimeMillis();
+ previouslyFired = true;
}
}
}
@@ -599,6 +602,10 @@ public class RulesEngine<T extends Ruleset> {
}
}
+ public boolean hasPreviouslyFired() {
+ return previouslyFired;
+ }
+
protected RulesEngineStatus getStatus() {
if (isRunning()) {
return RulesEngineStatus.RUNNING;
diff --git a/manager/src/main/java/org/openremote/manager/rules/RulesService.java b/manager/src/main/java/org/openremote/manager/rules/RulesService.java
index dab20c965..5f75fba3a 100644
--- a/manager/src/main/java/org/openremote/manager/rules/RulesService.java
+++ b/manager/src/main/java/org/openremote/manager/rules/RulesService.java
@@ -280,6 +280,7 @@ public class RulesService extends RouteBuilder implements ContainerService {
@Override
public void start(Container container) throws Exception {
+ startDone = false;
if (!geofenceAssetAdapters.isEmpty()) {
LOG.fine("GeofenceAssetAdapters found: " + geofenceAssetAdapters.size());
diff --git a/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java b/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java
index 74ad3e399..08b1fd7c6 100644
--- a/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java
+++ b/manager/src/main/java/org/openremote/manager/rules/RulesetDeployment.java
@@ -99,6 +99,7 @@ public class RulesetDeployment {
final protected HistoricDatapoints historicDatapointsFacade;
final protected PredictedDatapoints predictedDatapointsFacade;
final protected List<ScheduledFuture<?>> scheduledRuleActions = Collections.synchronizedList(new ArrayList<>());
+ final protected RulesEngine<?> rulesEngine;
protected final Logger LOG;
protected boolean running;
protected RulesetStatus status = RulesetStatus.READY;
@@ -108,11 +109,12 @@ public class RulesetDeployment {
protected CalendarEvent validity;
protected Pair<Long, Long> nextValidity;
- public RulesetDeployment(Ruleset ruleset, TimerService timerService,
+ public RulesetDeployment(Ruleset ruleset, RulesEngine<?> rulesEngine, TimerService timerService,
AssetStorageService assetStorageService, ScheduledExecutorService executorService,
Assets assetsFacade, Users usersFacade, Notifications notificationsFacade, Webhooks webhooksFacade,
Alarms alarmsFacade, HistoricDatapoints historicDatapointsFacade, PredictedDatapoints predictedDatapointsFacade) {
this.ruleset = ruleset;
+ this.rulesEngine = rulesEngine;
this.timerService = timerService;
this.assetStorageService = assetStorageService;
this.executorService = executorService;
@@ -288,7 +290,7 @@ public class RulesetDeployment {
protected boolean compileRulesJson(Ruleset ruleset) {
try {
- jsonRulesBuilder = new JsonRulesBuilder(LOG, ruleset, timerService, assetStorageService, executorService, assetsFacade, usersFacade, notificationsFacade, webhooksFacade, alarmsFacade, historicDatapointsFacade, predictedDatapointsFacade, this::scheduleRuleAction);
+ jsonRulesBuilder = new JsonRulesBuilder(LOG, ruleset, rulesEngine, timerService, assetStorageService, executorService, assetsFacade, usersFacade, notificationsFacade, webhooksFacade, alarmsFacade, historicDatapointsFacade, predictedDatapointsFacade, this::scheduleRuleAction);
for (Rule rule : jsonRulesBuilder.build()) {
LOG.finest("Registering JSON rule: " + rule.getName());
diff --git a/test/src/test/groovy/org/openremote/test/rules/AlarmRuleTest.groovy b/test/src/test/groovy/org/openremote/test/rules/AlarmRuleTest.groovy
index 1c32c507a..9d9dd9805 100644
--- a/test/src/test/groovy/org/openremote/test/rules/AlarmRuleTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/rules/AlarmRuleTest.groovy
@@ -112,7 +112,8 @@ class AlarmRuleTest extends Specification implements ManagerContainerTrait {
notificationMessages.clear()
}
- def "rule in realm with alarm action creates an alarm with severity '#severity', assignee '#assigneeId' and '#emailNotifications' emailNotifications based on attribute event"() {
+ @Shared
+ createAlarmRule = { severity, assigneeId ->
when: "a ruleset with a notification action is created in the building realm"
def rulesStr = getClass().getResource("/org/openremote/test/rules/CO2AlarmRule.json").text
JsonRulesetDefinition rulesetDef = ValueUtil.JSON.readValue(rulesStr, JsonRulesetDefinition.class)
@@ -131,10 +132,17 @@ class AlarmRuleTest extends Specification implements ManagerContainerTrait {
assert deployment.ruleset.version == realmRuleset.version
}
+ realmRuleset
+ }
+
+ def "rule in realm with alarm action creates an alarm with severity '#severity', assignee '#assigneeId' and '#emailNotifications' emailNotifications based on attribute event"() {
+ def realmRuleset = createAlarmRule(severity, assigneeId)
+
when: "the room linked attribute is updated"
assetProcessingService.sendAttributeEvent(new AttributeEvent(managerTestSetup.apartment2LivingroomId, "co2Level", 6000))
then: "the linked co2Level attribute should equal the event value"
+ def conditions = new PollingConditions(timeout: 10, delay: 0.2)
conditions.eventually {
def asset = assetStorageService.find(managerTestSetup.apartment2LivingroomId, true)
assert asset.getAttribute("co2Level").flatMap { it.getValue() }.orElse(null) == 6000
@@ -194,4 +202,53 @@ Value: 6000
Alarm.Severity.HIGH | alarmsReadWriteUserId | 1
}
+ def "rule does not create alarm when rules service is restarted"() {
+ def realmRuleset = createAlarmRule(Alarm.Severity.HIGH, null)
+
+ when: "the room linked attribute is updated"
+ assetProcessingService.sendAttributeEvent(new AttributeEvent(managerTestSetup.apartment2LivingroomId, "co2Level", 6000))
+
+ then: "the linked co2Level attribute should equal the event value"
+ def conditions = new PollingConditions(timeout: 10, delay: 0.2)
+ conditions.eventually {
+ def asset = assetStorageService.find(managerTestSetup.apartment2LivingroomId, true)
+ assert asset.getAttribute("co2Level").flatMap { it.getValue() }.orElse(null) == 6000
+ }
+
+ and: "one alarm is created"
+ conditions.eventually {
+ def alarms = alarmService.getAlarms(managerTestSetup.realmBuildingName, null, null, null)
+ assert alarms.size() == 1
+ }
+
+ when: "the rules service is stopped"
+ rulesService.stop(container)
+
+ then: "the realm engine and rule is no longer deployed"
+ conditions.eventually {
+ assert !rulesService.realmEngines.containsKey(managerTestSetup.realmBuildingName)
+ }
+
+ and: "the linked co2Level attribute still equals the event value"
+ def asset = assetStorageService.find(managerTestSetup.apartment2LivingroomId, true)
+ asset.getAttribute("co2Level").flatMap { it.getValue() }.orElse(null) == 6000
+
+ when: "the rules service is started"
+ rulesService.start(container)
+
+ then: "the rule is deployed again"
+ conditions.eventually {
+ def deployment = rulesService.realmEngines.get(managerTestSetup.realmBuildingName).deployments.get(realmRuleset.id)
+ assert deployment != null
+ assert deployment.ruleset.version == realmRuleset.version
+ }
+
+ and: "the number of created alarms remains the same"
+ def conditions2 = new PollingConditions(initialDelay: 5, timeout: 6, delay: 0.2)
+ conditions2.eventually {
+ def alarms = alarmService.getAlarms(managerTestSetup.realmBuildingName, null, null, null)
+ assert alarms.size() == 1
+ }
+ }
+
}