🪵 Add more logs and error boundaries in Label and Dashboard #1100
Conversation
This may help with debugging e-mission/e-mission-docs#986 (comment)
-added several try/catches to cover all top-level calls -added logDebug statements throughout, using `` for multi-line so they are not ugly -replaced any uses of the old Logger service
When metrics are fetched and stored as state, we can have more log statements and a try/catch.
| label: withErrorBoundary(LabelTab), | ||
| metrics: withErrorBoundary(MetricsTab), | ||
| control: withErrorBoundary(ProfileSettings), |
| if (mode == 'append') { | ||
| setTimelineMap(new Map([...timelineMap, ...readTimelineMap])); | ||
| } else if (mode == 'prepend') { | ||
| setTimelineMap(new Map([...readTimelineMap, ...timelineMap])); | ||
| } else if (mode == 'replace') { | ||
| setTimelineMap(readTimelineMap); | ||
| } else { | ||
| return console.error('Unknown insertion mode ' + mode); | ||
| return displayErrorMsg('Unknown insertion mode ' + mode); |
There was a problem hiding this comment.
nit: as I was looking through the logger code, I noticed that displayError displays the full stacktrace, but displayErrorMsg does not. Is there a reason why we would not want to include the backtrace?
There was a problem hiding this comment.
@JGreenlee I'm moving this to the "cleanup" column after the merge so that we can revisit how the logger should display errors.
There was a problem hiding this comment.
displayError accepts an Error object as a parameter. displayErrorMsg is used when there is no error and we just want to popup with some text.
Maybe in cases where there is no error, we should be throwing one ourselves and then print out that stacktrace?
There was a problem hiding this comment.
Maybe in cases where there is no error, we should be throwing one ourselves and then print out that stacktrace?
If we can do so easily, I think that would be helpful. Otherwise, we have to work backwards from the message to the code, and don't really have the full trace
There was a problem hiding this comment.
The stack traces are not very useful anyway because all the JS is bundled.
Maybe we could do something like https://stackoverflow.com/questions/58448000/how-to-get-a-readable-stack-trace-for-a-webpack-production-environment-for-a-min
In effort to more effectively debug e-mission/e-mission-docs#1025 and e-mission/e-mission-docs#986 (comment):
logDebugstatements throughout with nicer formattingtry/catchblocks, handled withdisplayErrorErrorBoundary. This means if one of them has an error on rendering (ie an error in the JSX / the React component itself, not one of our JS functions), that tab will be blank but the other tabs will not be affected.