feature: Debugging utilities + more user-friendly error listing #152
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
/debug: Added a /debug page that's only accessible if a fatal error in configuration has occurred. settings: The settings page now includes a debugging section with similar content to the debug page. This still needs styling but is otherwise OK.
cause: Issue causes are now displayed if they're provided. is-runtime: If an issue was discovered at runtime, they're prefixed with `Runtime` before the severity.
causes: Causes can now be error-like objects to provide more detail.
env-var: Setting the ALLOW_DEBUG environment variable to true allows you to access the debug page regardless of if an issue was detected.
tecc
force-pushed
the
feature/debugging
branch
from
3131298
to
11e2b79
Compare
store-config-debug: Previously, all store issues were reduced down to `Could not load configuration for store`. Now, along with that message, it provides more detailed messages for improperly configured credentials and more. misc: Reworded a few things as well.
detailed-fixes: Fixes for more common issues are now provided by Notea. Some are still missing steps. reformat: Simply reformatted using Prettier.
|
Right now, it's looking ready for merging. This is the current version of the |
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.
This PR introduces some more user-friendly debugging features that should help alleviate the need of opening issues here on the repository.
The main feature that is added is the debug page (or debug section of the settings page), which allows Notea to display issues it has detected whilst running. For example, if the server was configured improperly (say the store access key was not set), Notea will redirect you to the
/debugpage and tell you that the store configuration was not configured properly.Due to its implementation in this PR, the feature will not work as well as it can when using serverless/function-based architectures (i.e. hosting on Vercel or similar services) instead of having a central server.
It is also very rudimentary - it currently only handles configuration-related problems (albeit it is very easy to add more issues), and is not translated.
TODO: