fix: improve HTTP API error reporting with clean messages#1005
Open
fix: improve HTTP API error reporting with clean messages#1005
Conversation
Contributor
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🔴 👀 Review RequirementsThis rule is failing.
🔴 🔎 ReviewsThis rule is failing.
🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
There was a problem hiding this comment.
Pull request overview
This PR improves HTTP API error handling in the CLI by printing a concise, user-friendly error message (including parsed detail and request URL) and avoiding verbose request/response dumps unless --debug is enabled. It also prevents full tracebacks on httpx.HTTPStatusError by exiting cleanly from the CLI entrypoint.
Changes:
- Update
utils.check_for_status()to extractdetailfrom JSON responses and gate request/response dumps behind debug mode. - Add unit tests covering success, JSON-detail errors, plain-text errors, and debug/non-debug output behavior for
check_for_status. - Catch
httpx.HTTPStatusErrorincli.main()to exit with status code 1 without a traceback.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
mergify_cli/utils.py |
Prints clean API error messages and only dumps request/response details in debug mode. |
mergify_cli/tests/test_utils.py |
Adds tests validating new check_for_status output and debug gating behavior. |
mergify_cli/cli.py |
Converts uncaught httpx.HTTPStatusError into a clean exit code (no traceback). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Instead of showing raw JSON and a full Python traceback on API errors, display a clean error message with the parsed detail and URL. Request data and response body are only shown in --debug mode. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Change-Id: Id5587ccaf13364bf0971c63939a35b1a37ee2ef0 Claude-Session-Id: 09a673a1-bf69-48fa-8bca-73be84bab289
jd
force-pushed
the
devs/jd/worktree-better-error/Id5587ccaf13364bf0971c63939a35b1a37ee2ef0
branch
from
e064971 to
5b88eed
Compare
JulianMaurin
approved these changes
Mar 6, 2026
Contributor
🧪 CI InsightsHere's what we observed from your CI run for 5b88eed. 🟢 All jobs passed!But CI Insights is watching 👀 |
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.
Instead of showing raw JSON and a full Python traceback on API errors,
display a clean error message with the parsed detail and URL.
Request data and response body are only shown in --debug mode.
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com