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

Implement ConnectionError handler #57

Merged
merged 1 commit into from
Jan 23, 2024
Merged

Conversation

felipeall
Copy link
Owner

@felipeall felipeall commented Jan 23, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Improved exception handling in network requests to provide clearer error messages to users.

Copy link

vercel bot commented Jan 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
transfermarkt-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 23, 2024 5:31pm

Copy link

coderabbitai bot commented Jan 23, 2024

Walkthrough

The update to the codebase enhances the robustness of the make_request method by improving its exception handling capabilities. It now specifically addresses ConnectionError and a broader scope of exceptions, ensuring that each triggers an HTTPException with an appropriate status code and message, thereby providing clearer error feedback to the client.

Changes

File Path Change Summary
app/.../base.py Expanded exception handling in make_request to include ConnectionError and generic Exception, both raising HTTPException with relevant status codes and messages.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0d7bf48 and c1607dd.
Files selected for processing (1)
  • app/services/base.py (1 hunks)

Comment on lines +61 to +62
except ConnectionError:
raise HTTPException(status_code=500, detail=f"Connection error for url: {url}")
Copy link

Choose a reason for hiding this comment

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

Catching ConnectionError and raising an HTTPException with a 500 status code is not entirely appropriate. A ConnectionError typically indicates a problem with the network connection, which might be more accurately represented by a 503 Service Unavailable status code, as it suggests the service is temporarily unavailable.

-            raise HTTPException(status_code=500, detail=f"Connection error for url: {url}")
+            raise HTTPException(status_code=503, detail=f"Service Unavailable for url: {url}")

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
except ConnectionError:
raise HTTPException(status_code=500, detail=f"Connection error for url: {url}")
except ConnectionError:
raise HTTPException(status_code=503, detail=f"Service Unavailable for url: {url}")

Comment on lines +63 to +64
except Exception as e:
raise HTTPException(status_code=500, detail=f"Error for url: {url}. {e}")
Copy link

Choose a reason for hiding this comment

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

Catching a generic Exception is a good practice for capturing unexpected errors, but it's important to log these exceptions for debugging purposes. The current implementation only raises an HTTPException without logging, which could make it difficult to diagnose issues later on.

Consider logging the exception before raising the HTTPException to ensure that there is a record of what went wrong.

@felipeall felipeall merged commit c41e6b3 into main Jan 23, 2024
3 checks passed
@felipeall felipeall deleted the request-connection-error branch January 23, 2024 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant