[Reactor] Variables not updating correctly in latest-25201-2aa18550
-
I'd need a full picture of this... every variable and rule involved. This is a very complex area to look at.
Again, the key rule to understand here, is that the local variables in a Rule do not update every time a global or other local they refer to changes -- they only update when the Rule has been marked for evaluation. The recomputation of the local variable values occurs before trigger conditions are evaluated, and only then. That is very different from the way global variables are handled.
Also in your second example, the use of "==" is a "loose" comparison. The use of "===" is tighter and matches type. In your example, if
successis 0 (numeric), that will satisfy the testsuccess == false-- that's true because numeric 0 will cast to boolean false, so they are logically equal, although not exactly equal. That alone would explain unexpected results, if the values ofsuccesscan be other than true or false.@toggledbits "success" variable cannot be other than true or false, that I know.
But is it so that every time a rule is triggered, its local variables are evaluated (or should be evaluated) at least once?
Also, you wrote earlier: "If there's already a pending request for re-evaluation queued, new requests are ignored. This is all to prevent infinite loops in rule evaluations where rules manipulate devices and rule-based variables in Reactions that are also part of the rule's dependencies"
I was wondering if this could happen in cases where re-evaluation is queued but somehow gets stuck, and because new requests are ignored, updates won't occur?
Using MSR on Docker (Synology NAS), having InfluxDB, Grafana & Home Assistant, Hubitat C-8, Zigbee2MQTT & ZWA-2
-
@toggledbits "success" variable cannot be other than true or false, that I know.
But is it so that every time a rule is triggered, its local variables are evaluated (or should be evaluated) at least once?
Also, you wrote earlier: "If there's already a pending request for re-evaluation queued, new requests are ignored. This is all to prevent infinite loops in rule evaluations where rules manipulate devices and rule-based variables in Reactions that are also part of the rule's dependencies"
I was wondering if this could happen in cases where re-evaluation is queued but somehow gets stuck, and because new requests are ignored, updates won't occur?
@tunnus said in [Reactor] Variables not updating correctly in latest-25201-2aa18550:
I was wondering if this could happen in cases where re-evaluation is queued but somehow gets stuck, and because new requests are ignored, updates won't occur?
Well, they won't get stuck, but there is no guaranteed order to the re-evaluation. Other things waiting to execute can run before the re-evaluation happens, including things that could change the global variables or entity attributes on which the first Rule depends.
Here's something to try (it's the @therealdb solution he mentioned):
- Make
msgan expressionless local variable. - Before your notification, use a Set Variable or Script Action to compute the value of
msgthat you want to send in the notification.
Would look something like this:
...or this, using a Script Action...
I personally prefer the Script Action because you can set several variables at once in the script, if that's what you need, and the syntax looks cleaner (you don't have to use the
${{ }}substitution. - Make
-
Yep, I confirm I had to update a couple of rules where I had similar variables as @tunnus
I used script action because it’s multi line and definitely better in terms of readability.--
On a mission to automate everything. -
@tunnus said in [Reactor] Variables not updating correctly in latest-25201-2aa18550:
I was wondering if this could happen in cases where re-evaluation is queued but somehow gets stuck, and because new requests are ignored, updates won't occur?
Well, they won't get stuck, but there is no guaranteed order to the re-evaluation. Other things waiting to execute can run before the re-evaluation happens, including things that could change the global variables or entity attributes on which the first Rule depends.
Here's something to try (it's the @therealdb solution he mentioned):
- Make
msgan expressionless local variable. - Before your notification, use a Set Variable or Script Action to compute the value of
msgthat you want to send in the notification.
Would look something like this:
...or this, using a Script Action...
I personally prefer the Script Action because you can set several variables at once in the script, if that's what you need, and the syntax looks cleaner (you don't have to use the
${{ }}substitution.@toggledbits ok, I'll have to try script action. Still, as @therealdb stated, I'm also sure the "old style" used to work with pre-252xx builds.
Using MSR on Docker (Synology NAS), having InfluxDB, Grafana & Home Assistant, Hubitat C-8, Zigbee2MQTT & ZWA-2
- Make
-
@toggledbits ok, I'll have to try script action. Still, as @therealdb stated, I'm also sure the "old style" used to work with pre-252xx builds.
Some strange results happened while I was experimenting with script action. I noticed that the order of local variables had an effect whether those variables did update or not.
If I had e.g. the following order:
"peak_power" did not update. But if I switched places of "ok_to_reset" and "peak_power", "peak_power" started to update in real-time:
-
Post your script. Based on the instructions given, your local variables should be expressionless, so that seems wrong and I want to see what your script is trying to do.
I can tell you right now, if
ok_to_resetis expressionless and you are resetting it in the Script Action script, and expectingpeak_powerto see the updated value, it won't work.Author of Multi-system Reactor and Reactor, DelayLight, Switchboard, and about a dozen other plugins that run on Vera and openLuup.
-
Post your script. Based on the instructions given, your local variables should be expressionless, so that seems wrong and I want to see what your script is trying to do.
I can tell you right now, if
ok_to_resetis expressionless and you are resetting it in the Script Action script, and expectingpeak_powerto see the updated value, it won't work.@toggledbits that wasn’t what I was trying to convey here. Let’s forget script action for a moment as it has no relevance for my finding.
What I’m trying to say here is that by merely changing the order of variables (and to be clear, that setup has worked before), my rules are working again. Somehow new builds do not like if expressionless variables are in the middle of regular ones. If they are last in line, all is well. Sounds crazy, but please test.
-
I'll say again, local variables are not processed/evaluated in the same way as global variables. Local variables are only evaluated when the Rule to which they belong is being evaluated (i.e. its triggers are being checked). They are not evaluated when a dependent local variable is changed. When the Rule is evaluated, its local variables, if any, are evaluated before the triggers, and yes, they are evaluated in the order in which they are defined. That is known.
Combine this with using a Set Variable action... if you don't check the "Force re-evaluation" checkbox, any other local variables that use the variable being set will not be updated until the Rule is next evaluated. If you check the box, it forces a Rule evaluation, and it is the second evaluation that will update the dependent variables.
The Script Action is absolutely relevant in your case, at least from what you've posted, because you apparently still had local variables that are dependent on the local variable that the script was changing, and that was not consistent with my recommendation. The script will not cause the dependent variables to be updated, because there is no "Force re-evaluation" option for the script, and local variables are not dependency-scanned/triggered, as I said above. That means your script action will change the local variable
ok_to_reset, but that won't makepeak_powerchange immediately after. That is why I recommended that you make all local variables expressionless when using the Script Action, and do all of the work in the script, none of the work in the local variables' expressions.None of this is new. And again, no changes have been made to how variables (global or local) in any of these recent builds. The earlier changes you mentioned to make
isRuleSet()andisRuleEnabled()trigger with the rules they reference (build 25082 -- a long time ago) was a change to the implementation of those functions themselves , but was not in any way a change to the mechanism that handles changes in global expressions.Author of Multi-system Reactor and Reactor, DelayLight, Switchboard, and about a dozen other plugins that run on Vera and openLuup.
-
I'll say again, local variables are not processed/evaluated in the same way as global variables. Local variables are only evaluated when the Rule to which they belong is being evaluated (i.e. its triggers are being checked). They are not evaluated when a dependent local variable is changed. When the Rule is evaluated, its local variables, if any, are evaluated before the triggers, and yes, they are evaluated in the order in which they are defined. That is known.
Combine this with using a Set Variable action... if you don't check the "Force re-evaluation" checkbox, any other local variables that use the variable being set will not be updated until the Rule is next evaluated. If you check the box, it forces a Rule evaluation, and it is the second evaluation that will update the dependent variables.
The Script Action is absolutely relevant in your case, at least from what you've posted, because you apparently still had local variables that are dependent on the local variable that the script was changing, and that was not consistent with my recommendation. The script will not cause the dependent variables to be updated, because there is no "Force re-evaluation" option for the script, and local variables are not dependency-scanned/triggered, as I said above. That means your script action will change the local variable
ok_to_reset, but that won't makepeak_powerchange immediately after. That is why I recommended that you make all local variables expressionless when using the Script Action, and do all of the work in the script, none of the work in the local variables' expressions.None of this is new. And again, no changes have been made to how variables (global or local) in any of these recent builds. The earlier changes you mentioned to make
isRuleSet()andisRuleEnabled()trigger with the rules they reference (build 25082 -- a long time ago) was a change to the implementation of those functions themselves , but was not in any way a change to the mechanism that handles changes in global expressions.@toggledbits I’m not using script action currently, and those screenshots were from a rule that uses set variable action.
But could you test my finding? Even rule triggers are not relevant when reproducing this finding. Just put a variable referencing an entity which frequently changes as a first one. Then make expressionless variable second, and as a third one make some kind of expression which uses first variable and does some calculation with it. Observe what happens and then swap second and third line and again watch what happens.
-
I'll say again, local variables are not processed/evaluated in the same way as global variables. Local variables are only evaluated when the Rule to which they belong is being evaluated (i.e. its triggers are being checked). They are not evaluated when a dependent local variable is changed. When the Rule is evaluated, its local variables, if any, are evaluated before the triggers, and yes, they are evaluated in the order in which they are defined. That is known.
Combine this with using a Set Variable action... if you don't check the "Force re-evaluation" checkbox, any other local variables that use the variable being set will not be updated until the Rule is next evaluated. If you check the box, it forces a Rule evaluation, and it is the second evaluation that will update the dependent variables.
The Script Action is absolutely relevant in your case, at least from what you've posted, because you apparently still had local variables that are dependent on the local variable that the script was changing, and that was not consistent with my recommendation. The script will not cause the dependent variables to be updated, because there is no "Force re-evaluation" option for the script, and local variables are not dependency-scanned/triggered, as I said above. That means your script action will change the local variable
ok_to_reset, but that won't makepeak_powerchange immediately after. That is why I recommended that you make all local variables expressionless when using the Script Action, and do all of the work in the script, none of the work in the local variables' expressions.None of this is new. And again, no changes have been made to how variables (global or local) in any of these recent builds. The earlier changes you mentioned to make
isRuleSet()andisRuleEnabled()trigger with the rules they reference (build 25082 -- a long time ago) was a change to the implementation of those functions themselves , but was not in any way a change to the mechanism that handles changes in global expressions.@toggledbits have you had time to look at this? I suspect there’s a bug in evaluating local variables when expressionless variables are not last items in the list
-
It works as I would predict.
-
Yep, I confirm I had to update a couple of rules where I had similar variables as @tunnus
I used script action because it’s multi line and definitely better in terms of readability.@therealdb could you test this if you could get your original rules (variables) to work just by rearranging local expressions? My hypothesis being that expressionless variables should be last in the list
-
@therealdb & @toggledbits, below you can find my simple test case for this case. At least in my setup I can consistently reproduce this behaviour. (Still) using build 25208.
- First, make sure you have some device/entity which updates often (not strictly necessary, but it's faster to see the results & differences).
- Then put "target" variable immediately after "source", and "expressionlessVariable" should be the last one
- Now "target" should follow/change as "source" changes
- Next, swap "target" & "expressionlessVariable" (as seen in the image). Save.
- Now "target" ceases to update
-
It's probably moot at this point... I've just spent the last two weeks completely revamping the evaluation of Rule-based variables, to make them perform more like global variables, respect dependencies between them better, etc. The last week has just been a deep dive through the logs watching the performance of my own house on the updated approach.
I'll shortly be releasing a blind build with these changes, just for you (@tunnus) and @therealdb to try. I expect this to be disruptive, because any approaches in the logic that rely on specific behaviors and side-effects of the old approach will now work differently, maybe fail, and adapting to the new approach will be necessary. But, I think the new approach will produce a result that is much more in keeping with how you would expect it to work. So, sit tight... I'll be ready to build later today or early tomorrow.
Author of Multi-system Reactor and Reactor, DelayLight, Switchboard, and about a dozen other plugins that run on Vera and openLuup.
-
It's probably moot at this point... I've just spent the last two weeks completely revamping the evaluation of Rule-based variables, to make them perform more like global variables, respect dependencies between them better, etc. The last week has just been a deep dive through the logs watching the performance of my own house on the updated approach.
I'll shortly be releasing a blind build with these changes, just for you (@tunnus) and @therealdb to try. I expect this to be disruptive, because any approaches in the logic that rely on specific behaviors and side-effects of the old approach will now work differently, maybe fail, and adapting to the new approach will be necessary. But, I think the new approach will produce a result that is much more in keeping with how you would expect it to work. So, sit tight... I'll be ready to build later today or early tomorrow.
OK. Interim build latest-25248 for 64-bit docker systems only is up for testing/trials.
NOTE TO ALL USERS NOT CONTRIBUTING TO THIS THREAD — this is not an official build and you are advised not to upgrade to it just yet. This build is specifically for participants in this thread as we work to improve the behavior of Rule-based variables. Wait for a build advertised in the official announcement thread before upgrading your system.
Behavior of Rule-based variables now:
- Will still be re-evaluated when the Rule is started, and any time the Rule is subject to trigger condition check (i.e. behavior not changed);
- When the trigger condition check occurs, Rule-based variables are always evaluated/updated before trigger conditions (i.e. also same as before);
- Rule-based variables may be modified by Set Variable action and assignment statements in Script Actions in Rule Reactions (unreliable before);
- If a Rule-based variable references another Rule-based variable, and the latter changes, the former will be re-evaluated (now same as Global Variables).
- The order of Rule-based variables doesn't matter, it's just for your convenience. Dependencies between variables are established at startup, and evaluation takes place in dependency tree order, not the order shown in the UI (now same as Global Variables).
If you run into an issue you can't resolve, here's what I ask:
-
Make sure your expectations are aligned with the changes above; make sure you are not relying on any prior behavior or side-effect of the prior behavior.
-
Enable logging for the rule in question. Put a snippet like below in your
logging.yamlfile (replace the part after#with your rule ID):"Rule#rule-l3hj06aa": level: 5 streams: - type: file # filename is derived from rule ID keep: 2 level: 999 recycle: true -
Restart Reactor and get the rule in question to demonstrate whatever the issue is. Make sure to then capture the log file called
Logger#Rule#XXX.log... I will be asking for it. -
Report the issue here on this thread, with all of the usual attention to posting requirements: good, detailed description; expectations of behavior; clear description of what's not meeting expectations; etc.
-
I will PM you a URL where you can upload the log file and your rule JSON file (from
storage/rules) if necessary.
The locally-installed version of the documentation is also updated.
-
OK. Interim build latest-25248 for 64-bit docker systems only is up for testing/trials.
NOTE TO ALL USERS NOT CONTRIBUTING TO THIS THREAD — this is not an official build and you are advised not to upgrade to it just yet. This build is specifically for participants in this thread as we work to improve the behavior of Rule-based variables. Wait for a build advertised in the official announcement thread before upgrading your system.
Behavior of Rule-based variables now:
- Will still be re-evaluated when the Rule is started, and any time the Rule is subject to trigger condition check (i.e. behavior not changed);
- When the trigger condition check occurs, Rule-based variables are always evaluated/updated before trigger conditions (i.e. also same as before);
- Rule-based variables may be modified by Set Variable action and assignment statements in Script Actions in Rule Reactions (unreliable before);
- If a Rule-based variable references another Rule-based variable, and the latter changes, the former will be re-evaluated (now same as Global Variables).
- The order of Rule-based variables doesn't matter, it's just for your convenience. Dependencies between variables are established at startup, and evaluation takes place in dependency tree order, not the order shown in the UI (now same as Global Variables).
If you run into an issue you can't resolve, here's what I ask:
-
Make sure your expectations are aligned with the changes above; make sure you are not relying on any prior behavior or side-effect of the prior behavior.
-
Enable logging for the rule in question. Put a snippet like below in your
logging.yamlfile (replace the part after#with your rule ID):"Rule#rule-l3hj06aa": level: 5 streams: - type: file # filename is derived from rule ID keep: 2 level: 999 recycle: true -
Restart Reactor and get the rule in question to demonstrate whatever the issue is. Make sure to then capture the log file called
Logger#Rule#XXX.log... I will be asking for it. -
Report the issue here on this thread, with all of the usual attention to posting requirements: good, detailed description; expectations of behavior; clear description of what's not meeting expectations; etc.
-
I will PM you a URL where you can upload the log file and your rule JSON file (from
storage/rules) if necessary.
The locally-installed version of the documentation is also updated.
@toggledbits whoops... guess this is one time having the system auto-update containers with new images is bad....
So I'm on the test version. Found this:
This is a Dynamic Group I'd created forever ago:
My ruleset:
I added the snippet as noted into my
logging.yamlfile:
When it didn't work I checked my yaml and found a spacing issue. That's been corrected, I now have a proper
logger*log. Will upload to our pre-x Dropbox in folder25248 logsalong with the rule JSON file. -
Is there a global variable called
dead(it's not shown above)?Or are you looking for the word dead in
status_text? Because if it's that, your expression is incorrectly formed. -
Is there a global variable called
dead(it's not shown above)?Or are you looking for the word dead in
status_text? Because if it's that, your expression is incorrectly formed.@toggledbits kicker is: this has been working for a long while. Dead iblind nodes (far too common, btw) get caught and pinged and I get the alerts on my phone.
I don't see a Global Expression called
deadand, yes, I believe when I wrote this I was looking for either a status of3orstatus_textof dead. -
OK. Yes, the new build also has some new error reporting. That message was probably being logged, but since you weren't looking at the logs, you didn't see it.
You can also combine those into one status test, which will be a good bit more efficient:
- id: groups enabled: true implementation: DynamicGroupController name: Dynamic Group Controller config: groups: zwavejs_dead: select: - include_group: zwavejs filter_expression: < entity?.attributes?.zwave_device?.status === 3 || entity?.attributes?.zwave_device?.status_text === "dead"Also, please... Please... PLEASE do not screen shot pure text. Use the fenced code block formatting here for text like expressions, configs, logs, etc. It may be expeditious for you to just paste the screen shot, but when I try to give you suggestions or corrections like the above, I have to retype the entire block (I can't copy-paste the text and update it). That not only takes a bunch of time, but also introduces the possibility that I will make a typo in the part we don't care about and leave you with a non-working example we then need to fix in yet another series of post replies.
Don't forget to remove the Rule logging when it isn't needed.
-
OK. Yes, the new build also has some new error reporting. That message was probably being logged, but since you weren't looking at the logs, you didn't see it.
You can also combine those into one status test, which will be a good bit more efficient:
- id: groups enabled: true implementation: DynamicGroupController name: Dynamic Group Controller config: groups: zwavejs_dead: select: - include_group: zwavejs filter_expression: < entity?.attributes?.zwave_device?.status === 3 || entity?.attributes?.zwave_device?.status_text === "dead"Also, please... Please... PLEASE do not screen shot pure text. Use the fenced code block formatting here for text like expressions, configs, logs, etc. It may be expeditious for you to just paste the screen shot, but when I try to give you suggestions or corrections like the above, I have to retype the entire block (I can't copy-paste the text and update it). That not only takes a bunch of time, but also introduces the possibility that I will make a typo in the part we don't care about and leave you with a non-working example we then need to fix in yet another series of post replies.
Don't forget to remove the Rule logging when it isn't needed.
@toggledbits now I'm feeling hypocritical as I'm the guy at work chastising the Support folks for giving me screenshots for the exact reasons you noted.
Change deployed.
Got this upon restart of MSR:
at _ClientAPI._commandTimeout (http://192.168.1.100:8111/client/ClientAPI.js:594:125)Cleared it and refreshed the tab and all seems fine. Removing logging snippet.
Thank you, sir!