Improve message on missing auth file #271
Open
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR improves the user experience when authentication files are missing by replacing generic error messages with more helpful, actionable feedback. Instead of a cryptic "Failed to load authentication" panic, users now see clear guidance to run screenly login.
Key Changes:
- Introduced helper functions to provide context-aware authentication error messages
- Replaced panic-on-error pattern with graceful error handling and user-friendly messages
- Added test coverage for the new error message formatting
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "Not logged in. Please run `screenly login` first to authenticate.".to_string() | ||
| } | ||
| _ => { | ||
| format!("Authentication error: {e}. Please run `screenly login` to authenticate.") |
There was a problem hiding this comment.
The error message includes a period before 'Please run' which creates awkward punctuation. Consider restructuring to: format!("Authentication error: {}. Please run screenly login to authenticate.", e) or removing the period after {e} if the underlying error already contains terminal punctuation.
Suggested change
| format!("Authentication error: {e}. Please run `screenly login` to authenticate.") | |
| format!("Authentication error: {}. Please run `screenly login` to authenticate.", e) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What does this PR do?
Improves message on missing authentication file.
GitHub issue or Phabricator ticket number?
#270
How has this been tested?
By running CLI without authentication file.