Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse the error stack on the error info page #224

Open
rowanmanning opened this issue Oct 11, 2022 · 0 comments
Open

Parse the error stack on the error info page #224

rowanmanning opened this issue Oct 11, 2022 · 0 comments
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

Comments

@rowanmanning
Copy link
Member

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):

vscode://file/<PATH_TO_FILE>:<LINE>:<COL>

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

@rowanmanning rowanmanning added enhancement New feature or request package: middleware-render-error-info Relates to the middleware-render-error-info package labels Oct 11, 2022
@rowanmanning rowanmanning moved this to 📥 Inbox in Reliability Kit Roadmap Oct 11, 2022
@rowanmanning rowanmanning added the requested Used to indicate that a team outside of the maintainers of this repo has requested this work label Oct 17, 2022
@rowanmanning rowanmanning moved this from 📥 Inbox to 📝 Planned (future) in Reliability Kit Roadmap Oct 24, 2022
@rowanmanning rowanmanning moved this from 📝 Planned (future) to 📥 Inbox in Reliability Kit Roadmap Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Status: 📥 Inbox
Development

No branches or pull requests

1 participant