Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: added proper support for remote protocol error from Blizzard #231

Merged
merged 2 commits into from
Mar 4, 2025

Conversation

TeKrop
Copy link
Owner

@TeKrop TeKrop commented Mar 4, 2025

Summary by Sourcery

Handle httpx.RemoteProtocolError exceptions when querying the Blizzard API, returning a 504 Gateway Timeout error to the client.

Bug Fixes:

  • Handle RemoteProtocolError exceptions from the Blizzard API, returning a 504 Gateway Timeout error.
  • Update the API version to 3.9.4.

@TeKrop TeKrop added the bug Something isn't working label Mar 4, 2025
@TeKrop TeKrop self-assigned this Mar 4, 2025
Copy link
Contributor

sourcery-ai bot commented Mar 4, 2025

Reviewer's Guide by Sourcery

This pull request adds proper support for handling RemoteProtocolError exceptions from the Blizzard API when making HTTP requests. It also updates the project version.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added handling for RemoteProtocolError exceptions raised by httpx when communicating with the Blizzard API.
  • Added a new test case to simulate a RemoteProtocolError from Blizzard.
  • Modified the get method in OverFastClient to catch RemoteProtocolError exceptions.
  • When a RemoteProtocolError is caught, it raises a custom exception with a status code of 0 and a descriptive error message.
tests/players/test_player_career_route.py
app/overfast_client.py
Updated the version of the project.
  • Incremented the project version from 3.9.3 to 3.9.4 in pyproject.toml.
pyproject.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @TeKrop - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment to explain why the status code is HTTP_504_GATEWAY_TIMEOUT instead of another 5xx error.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copy link

sonarqubecloud bot commented Mar 4, 2025

@TeKrop TeKrop merged commit bade464 into main Mar 4, 2025
4 checks passed
@TeKrop TeKrop deleted the bugfix/remote-protocol-error-support branch March 4, 2025 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant