fix(notifications): handle Error type messages #305
Merged
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.
Fixes #304
The root cause of the bug is that services and components may attempt to display a notification with an Error object as the message to display to the user. This fails because the rendered child component (content of the graphical notification) must be a string. This is a bit tricky because the Notification data type specifies that the message property should be a string, however many/most places where an Error object may be obtained it is typed as 'any', which breaks some of the TS compiler's type-checking guarantees at compile time. To work around this, I apply a simple fix to the notifications service: do a runtime check of the message type, and if it isn't an actual string, apply "JSON.stringify" to serialize it to a string before it is displayed.