chore: move analytics error handling in the plugin component #3335
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
So the same error screens are shown in both dashboard and DV app.
|
🚀 Deployed on https://pr-3335.data-visualizer.netlify.dhis2.org |
| DIMENSION_ID_DATA | ||
| ]?.every( | ||
| (dim) => | ||
| response.metaData.items[dim]?.valueType === |
There was a problem hiding this comment.
On line 227 you check defined for both response and metadata. Any need to do that here as well?
There was a problem hiding this comment.
This was existing code moved from the Visualization component.
231 makes sure there is dim in the items object before reading valueType, it seems better to leave this check.
response and metaData are not checked again here.
Now the VisualizationErrorInfo component is used also outside the StartScreen component.
This happens when a layout error is thrown before the plugin is rendered. Without this, the error is shown briefly before the VisualizationPlugin is rendered and might crash due to other uncaught errors.
edoardo
commented
Feb 6, 2025
|
2 tasks
HendrikThePendric
approved these changes
Feb 10, 2025
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.
Key features
Description
DV has a number of custom error screens where a user friendly error is shown to the user.
The
errorCodereturned in the analytics response is used to choose the error screen to show.This error handling was done in the DV app components before, an
onErrorcallback was passed to the plugin component and used to pass the error back to the app.Dashboard app also used the
onErrorcallback, but it didn't have all the custom error screen so a generic error was shown instead where the original error string from the analytics api was shown.This error string is often obscure for the end user, and can also contain ids and other information intended more for admins or developers for debugging purposes.
When an error occured in a plugin, and the visualization was opened in the DV app, a different error was shown.
By moving the error handling in the plugin component, the same custom error screens are used in both the DV and dashboard apps.
TODO
Screenshots
Before, no custom screen for E7120 in DV (already used in LL):
After, new custom error for E7120 (same text as in LL):
Same error screen used in dashboard app:
