RFC: Rework error handling

[akphi]

💬 Request for Comments

The way to handle exception/errors right now is not systematic and potentially can cause bugs to be uncaught. This is bad because we can throw errors at users and cause the app to crash unintentionally.

Context and Motivation

• Use alertIllegalUnhandledError to assert uncaught exceptions are not crashing the app at component-level
• Wrap try-catch around each call instead of a using a catch-all block for important logics: Refactor critical path to use an approach similar to that of finos/legend-sdlc for error-handling (make the code verbose but very clear to read - we have try-catch around each call that might pose a problem, we learn how SDLC server methods like buildException that will build the exception (for 404, 403, etc.) and bypass already built exception, i.e. MetadataException (in our case StudioError or ApplicationError) - This might be a substantial piece of work
• Consider using error-boundary where appropriate to handle UI issues (probably we can do catch-all somewhere) - https://www.npmjs.com/package/react-error-boundary
• Reconsider how we throw errors while processing/building the graph. Right now we throw whatever types of error and wrap them with GraphError outside, is this the right thing to do?
• Give better logging event, right now we use very generic logging event like SDLC_PROBLEM, SETUP_PROBLEM, those events are clearly not useful at all, we should make them more specific and if we follow the refactor for try/catch usage as detailed above, we should be able to use a proper logging event for each try/catch block
• Especially, to handle something like Bug: Authentication token expired and not re-fetched after opening the editor for a long time #334, we should have a method like handleNetworkError() that will handle 401, 404, 403 and the likes systematically.