Enhance error handling in download_file function to include HTTPError and RequestException

[anitacaron]

Fix #149

Summary by CodeRabbit

• New Features

  • Enhanced error handling for file downloads, providing more specific logging and retry capabilities for various error types.

• Bug Fixes

  • Improved robustness of the download functionality by addressing potential issues with HTTP errors and transient errors.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing the error handling capabilities of the download_file function within the util/lib.py file. The import statements for exceptions have been updated to include HTTPError and RequestException, alongside ChunkedEncodingError. The error handling logic has been refined to first catch HTTPError, allowing for immediate logging and response if a URL is unreachable. The existing handling for ChunkedEncodingError is maintained, now preceded by a catch for RequestException, which includes detailed logging for retry attempts.

Changes

File	Change Summary
util/lib.py	Updated exception imports and enhanced error handling in download_file function.

Assessment against linked issues

Objective	Addressed	Explanation
Improve error handling for non-existent URLs (#149)	✅
Log detailed error messages for HTTP errors (#149)	✅

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3a31a0e and 072f1f1.

📒 Files selected for processing (1)

• util/lib.py (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• util/lib.py

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)

util/lib.py (2)

602-612: Refactor retry logic to reduce code duplication

The exception handling for ChunkedEncodingError and RequestException contains similar retry logic.

Consider combining the retry logic:

-       except ChunkedEncodingError as e:
-           logging.warning(
-               "ChunkedEncodingError encountered: %s. Retrying %s/%s...",
-               e, attempt + 1, retries
-           )
-       except RequestException as e:
+       except (ChunkedEncodingError, RequestException) as e:
            logging.warning(
-               "Failed to download %s: %s (%s). Retrying %s/%s...",
-               url, e, type(e).__name__, attempt + 1, retries
+               "Download error: %s (%s). Retrying %s/%s...",
+               e, type(e).__name__, attempt + 1, retries
            )

---

Line range hint 583-583: Consider making timeout configurable

The timeout value is hardcoded to 1000000 seconds (≈11.6 days), which seems excessive.

Consider making it configurable:

-def download_file(url, dest_path, retries=3):
+def download_file(url, dest_path, retries=3, timeout=3600):
     attempt = 0
     while attempt < retries:
         try:
-            response = requests.get(url, stream=True, timeout=1000000)
+            response = requests.get(url, stream=True, timeout=timeout)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3d7d3b0 and 3a31a0e.

📒 Files selected for processing (1)

• util/lib.py (2 hunks)

🔇 Additional comments (1)

util/lib.py (1)

14-15: LGTM: Import changes align with enhanced error handling requirements

The addition of HTTPError and RequestException imports supports the improved error handling strategy.

[matentzn]

LGTM;

I am assuming you know what you are doing removing

except Exception as e:

Which could bring the whole house down crashing if you are not super sure!

[anitacaron]

I changed to a more specific exception because it'll only have 'request exceptions' in this function.