enhance: improve error messages with contextual details (closes #577)#890
Open
TorranceTech wants to merge 1 commit into
Open
enhance: improve error messages with contextual details (closes #577)#890TorranceTech wants to merge 1 commit into
TorranceTech wants to merge 1 commit into
Conversation
Adds file paths, error context, and actionable hints to five vague exception log messages across auth, scan, encoding, and init modules. Closes pyupio#577 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Summary
Addresses #577 by improving five vague exception log messages that previously gave no context about what failed or where.
Changes
auth/server.pyLOG.exception(e)LOG.exception("Authentication failed unexpectedly: %s", e)encoding.py"Error detecting encoding""Error detecting encoding for file %s, falling back to utf-8"codebase_utils.py"Error saving project info""Error saving project info to %s"scan/ecosystems/target.py"Error opening file""Error opening file %s for scanning"init/main.py"Unable to load data on the init command""Unable to load organization data during init. Check your authentication and network connectivity."Why this matters
auth/server.pyfix replaces a bareLOG.exception(e)(which duplicates the exception object as the message) with a proper descriptive string.init/main.pymessage now includes an actionable hint for the most common root causes (auth/network).