Parse the error stack on the error info page #224
Labels
enhancement
New feature or request
package: middleware-render-error-info
Relates to the middleware-render-error-info package
requested
Used to indicate that a team outside of the maintainers of this repo has requested this work
The error stack displayed on the error info page could be a lot richer and more useful.
What problem does this feature solve?
There's currently very little linking between the error info page and an engineer's coding environment. @kavanagh also complained that the error stack was cut off and that he's used to having more visibility.
Ideal solution
We should parse the error stack on this page, consider how it's displayed, and potentially include links to the relevant lines on GitHub and/or VS Code. We should probably rely on a third-party module for the parsing as it could be a lot of code to maintain, there's a fairly well-maintained library here.
Link to the line of code on GitHub might be difficult, especially if there are local changes. We don't really want to read git history etc to work out whether the local code/branch exists on GitHub so maybe that's a no-go.
Linking to the code in VS Code is relatively easy as the app registers a new protocol (source):
Alternatives
We could not do anything and accept that the error stack isn't quite as easy to read as via the logs (which should also be there when developing locally).
We could display the error stack nicely without worrying about things like VS Code linking, which would reduce the amount of work. It'd be nice to go above and beyond what you can get from the command line though to make using the error page more compelling
See also
CPREL-272
The text was updated successfully, but these errors were encountered: