fix(cmd): return an error instead of panic#820
Merged
Conversation
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the start CLI command to return errors to Cobra instead of panicking, improving runtime robustness and allowing the CLI to exit cleanly on configuration/startup failures.
Changes:
- Switch
startcommand handler fromRuntoRunE. - Replace
panic(err)with returned, wrapped errors for config unmarshalling. - Return
Start(...)error directly to the CLI framework.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| panic(err) | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if err := viper.Unmarshal(&conf); err != nil { | ||
| return fmt.Errorf("unable to read configuration file: %w", err) |
There was a problem hiding this comment.
The error text is misleading: viper.Unmarshal can fail due to decode/type issues from flags/env as well, not just reading a configuration file. Consider changing the message to reflect unmarshalling/decoding (e.g., "unable to decode configuration") or include the config source when known.
Suggested change
| return fmt.Errorf("unable to read configuration file: %w", err) | |
| return fmt.Errorf("unable to decode configuration: %w", err) |
Comment on lines
+25
to
+30
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if err := viper.Unmarshal(&conf); err != nil { | ||
| return fmt.Errorf("unable to read configuration file: %w", err) | ||
| } | ||
|
|
||
| err = Start(cmd.Context(), conf) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return Start(cmd.Context(), conf) |
There was a problem hiding this comment.
This change switches the command to RunE and introduces a new error-returning path (instead of panicking) when config unmarshalling fails. There doesn't appear to be a test that asserts start returns an error (and does not panic) for an invalid config value; adding one would prevent regressions and validate the new behavior.
|
|
✅ All tests successful. No failed tests were found. 📣 Thoughts on this report? Let Codecov know! | Powered by Codecov |
Codecov Report❌ Patch coverage is
|
This file contains hidden or 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
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.
No description provided.