-
Notifications
You must be signed in to change notification settings - Fork 170
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
Improve error messages when server misconfigured #1520
Merged
Merged
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
- add better error message for missing JWT secret - print configuration errors in friendlier format and exit with code 1
jameshiew
commented
Nov 16, 2024
Thanks for reviewing! I've updated to
|
svix-jplatte
approved these changes
Nov 19, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
svix-onelson
approved these changes
Nov 19, 2024
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.
Motivation
Relates to #1435
This PR is trying out a way to improve the error message shown when something is misconfigured.
Currently running the server binary (
cargo run
in thesvix-server/
folder) panics when some needed config is missing.e.g.
listen_address
not sete.g.
jwt_secret
not set - in this case the error message doesn't indicate the missing field due to an issue with it coming from an inlined struct insideConfigurationInner
- SergioBenitez/Figment#80Solution
If
cfg::load()
errors out, terminate with exit code 1 and print the formatted error to stderr. I tried switching to usinganyhow::Result
formain()
andcfg::load()
to make propagating errors with human friendly context easier.Check upfront that
jwt_secret
is set and override the error message to be more helpful due to SergioBenitez/Figment#80