Add error display to core widgets. #2129
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vineeththomasalex
approved these changes
Jan 12, 2024
AmelBawa-msft
approved these changes
Jan 17, 2024
| @@ -86,6 +86,11 @@ public override void LoadContentData() | |||
| catch (Exception e) | |||
| { | |||
| Log.Logger()?.ReportError(Name, ShortId, "Error retrieving data.", e); | |||
| var content = new JsonObject | |||
There was a problem hiding this comment.
Consider promoting error message object creation to a method in the parent class (reusability + maintenance)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the pull request
Core widgets currently do not set ContentData to anything on error, which causes them to display an empty template with variable names with no indication of what is wrong. This change adds an error message to the main template for each of the core widgets, and populates that message with any exception errors when encountered so it is obvious to the user that something is wrong. If there is no error message, then the templates display as normal, but if there is an error message that is displayed instead.
References and relevant issues
Closes #1248
Detailed description of the pull request / Additional comments
The diff of the templates looks like a lot changed, but the actual change was adding a new container for the error message and then shifting the previous content to be in a second container mutually exclusive with the error container. Shifting it one indentation level made for a messy JSON diff.
Validation steps performed
PR checklist