-
-
Notifications
You must be signed in to change notification settings - Fork 429
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Display raw item state when formatting fails #2349
Display raw item state when formatting fails #2349
Conversation
With the addition of Profiles, there are situations where a Channel sends format information that does not match the type. For example, "Timestamp on update" always sends a DateTime, but the channel may specify a different format (e.g., if it is a battery level, "%.0f %%"). In such a case, we attempt to format the DateTime according to the pattern, it (predictably and correctly) fails, and this results in an error in the UI and a warning in the log. While this is an expected error if a user uses an incorrect format code in an Item's metadata (user error), it is somewhat unexpected if a user is choosing an option as presented in the UI. Because this is purely a formatting issue, one solution is to direct users to add a formatting code if they see an error. However, the disadvantage of this approach is that it doesn't work "out of the box." This patch attempts to address the issue by displaying the raw Item state when formatting fails instead of displaying "Err". This should provide a more balanced approach with a predictable outcome. In addition, when a user is intentionally changing the pattern via metadata and gets it wrong, they should still see info in the log that helps them get to the root of the problem, but I've changed it from warn to info so it will be a little less noisy for those who choose to ignore it. This solution was discussed in #2037 and https://community.openhab.org/t/timestamps-not-rendering-consistently-in-ui-3-0-2/121891/2 Thank you to @Rossko57 and @cweitkamp for their help in figuring it out, and in suggesting the solution. Fixes #2037 Signed-off-by: Brian Warner <brian@bdwarner.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contribution.
Our static-code-analysis tool is not happy with your changes. You can fix it by running mvn spotless:apply
in the related folder.
If you want to keep the feedback to the user than a WARNING is the correct log level. If not, you should decrease it to DEBUG.
Signed-off-by: Brian Warner <brian@bdwarner.com>
This commit further reduces noise when the format of an item does not match the data type. Signed-off-by: Brian Warner <brian@bdwarner.com>
Thanks @cweitkamp, turns out it was a linter error. Easy fix once I got Maven up and running. I pushed two commits, one that satisfies the linter, and another that changes the log level to DEBUG. I also saw @Rossko57's comment on the issue that there may be a more comprehensive way to solve this, although to be honest I'm at the boundaries of my knowledge on what else would need to be changed. Happy to look into other ways to solve this, as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks.
Lets keep the issue as this maybe is not the final solution but a small step forward.
* Display raw item state when formatting fails With the addition of Profiles, there are situations where a Channel sends format information that does not match the type. For example, "Timestamp on update" always sends a DateTime, but the channel may specify a different format (e.g., if it is a battery level, "%.0f %%"). In such a case, we attempt to format the DateTime according to the pattern, it (predictably and correctly) fails, and this results in an error in the UI and a warning in the log. While this is an expected error if a user uses an incorrect format code in an Item's metadata (user error), it is somewhat unexpected if a user is choosing an option as presented in the UI. Because this is purely a formatting issue, one solution is to direct users to add a formatting code if they see an error. However, the disadvantage of this approach is that it doesn't work "out of the box." This patch attempts to address the issue by displaying the raw Item state when formatting fails instead of displaying "Err". This should provide a more balanced approach with a predictable outcome. In addition, when a user is intentionally changing the pattern via metadata and gets it wrong, they should still see info in the log that helps them get to the root of the problem, but I've changed it from warn to info so it will be a little less noisy for those who choose to ignore it. This solution was discussed in openhab#2037 and https://community.openhab.org/t/timestamps-not-rendering-consistently-in-ui-3-0-2/121891/2 Thank you to @Rossko57 and @cweitkamp for their help in figuring it out, and in suggesting the solution. Signed-off-by: Brian Warner <brian@bdwarner.com>
* Display raw item state when formatting fails With the addition of Profiles, there are situations where a Channel sends format information that does not match the type. For example, "Timestamp on update" always sends a DateTime, but the channel may specify a different format (e.g., if it is a battery level, "%.0f %%"). In such a case, we attempt to format the DateTime according to the pattern, it (predictably and correctly) fails, and this results in an error in the UI and a warning in the log. While this is an expected error if a user uses an incorrect format code in an Item's metadata (user error), it is somewhat unexpected if a user is choosing an option as presented in the UI. Because this is purely a formatting issue, one solution is to direct users to add a formatting code if they see an error. However, the disadvantage of this approach is that it doesn't work "out of the box." This patch attempts to address the issue by displaying the raw Item state when formatting fails instead of displaying "Err". This should provide a more balanced approach with a predictable outcome. In addition, when a user is intentionally changing the pattern via metadata and gets it wrong, they should still see info in the log that helps them get to the root of the problem, but I've changed it from warn to info so it will be a little less noisy for those who choose to ignore it. This solution was discussed in openhab#2037 and https://community.openhab.org/t/timestamps-not-rendering-consistently-in-ui-3-0-2/121891/2 Thank you to @Rossko57 and @cweitkamp for their help in figuring it out, and in suggesting the solution. Signed-off-by: Brian Warner <brian@bdwarner.com> GitOrigin-RevId: a8f469e
With the addition of Profiles, there are situations where a Channel sends format information that
does not match the type. For example, "Timestamp on update" always sends a DateTime, but the channel
may specify a different format (e.g., if it is a battery level, "%.0f %%"). In such a case, we
attempt to format the DateTime according to the pattern, it (predictably and correctly) fails, and
this results in an error in the UI and a warning in the log.
While this is an expected error if a user uses an incorrect format code in an Item's metadata (user
error), it is somewhat unexpected if a user is choosing an option as presented in the UI. Because
this is purely a formatting issue, one solution is to direct users to add a formatting code if they
see an error. However, the disadvantage of this approach is that it doesn't work "out of the box."
This patch attempts to address the issue by displaying the raw Item state when formatting fails
instead of displaying "Err". This should provide a more balanced approach with a predictable
outcome. In addition, when a user is intentionally changing the pattern via metadata and gets it
wrong, they should still see info in the log that helps them get to the root of the problem, but
I've changed it from warn to info so it will be a little less noisy for those who choose to ignore
it.
This solution was discussed in #2037 and
https://community.openhab.org/t/timestamps-not-rendering-consistently-in-ui-3-0-2/121891/2
Thank you to @Rossko57 and @cweitkamp for their help in figuring it out, and in suggesting the
solution.
Fixes #2037
Signed-off-by: Brian Warner brian@bdwarner.com