improve error message when av.db is corrupted#683
improve error message when av.db is corrupted#683aviator-app[bot] merged 1 commit intoaviator-co:masterfrom
Conversation
Current Aviator status
This PR was merged using Aviator.
See the real-time status of this PR on the
Aviator webapp.
Use the Aviator Chrome Extension
to see the status of your PR within GitHub.
|
✅ FlexReview StatusCommon Owner:
Review SLO: |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the user experience by providing more actionable and informative error messages when the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request improves the error handling for a corrupted database by providing a more informative error message with recovery steps. The change is a good improvement for user experience. I have one suggestion regarding maintainability by defining the error message as a constant.
| db, exists, err := jsonfiledb.OpenPath(dbPath) | ||
| if err != nil { | ||
| return nil, false, errors.WrapIff(err, | ||
| "failed to open av database at %q (the file may be corrupted; try deleting it and running 'av init')", |
There was a problem hiding this comment.
Hardcoding user-facing error messages like this can lead to maintainability issues. If this message needs to be changed, it might be missed if it's duplicated elsewhere. Also, it makes the code harder to read. Consider defining this format string as a package-level constant. This improves code clarity and makes future updates easier and safer.
Wrap the database open error with a user-friendly message that names the file path and suggests deleting the file and running 'av init'. Previously a corrupted av.db would produce an unclear JSON parse error without actionable guidance. Closes aviator-co#514 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
601fd94 to
92a0d3a
Compare
When av.db contains invalid JSON, commands crash with a raw JSON parse error. This wraps the error in getOrCreateDB with the file path and recovery instructions (delete file and run av init).
Closes #514
This contribution was developed with AI assistance (Claude Code).