fix: Added incomplete file removal!

[amindadgar]

not to face errors when the crawling is interrupted!

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling during data extraction to ensure incomplete data is properly cleaned up if an error occurs. Users may notice more reliable operation and fewer issues related to partial or failed data imports.

[coderabbitai]

Walkthrough

The extract method within the MediawikiETL class has been updated to include exception handling for the crawling process. If an error occurs during the call to self.wikiteam_crawler.crawl(api_url, dump_dir), the exception is now caught, logged, and triggers a cleanup process that removes any partially dumped data by deleting the dump directory. After cleanup, the exception is re-raised. This change is internal and does not modify any public interfaces.

Changes

File(s)	Change Summary
hivemind_etl/mediawiki/etl.py	Added exception handling and cleanup logic to the extract method in the MediawikiETL class.

Poem

A hiccup in the crawl? Don’t fear,
For now our code will persevere.
If trouble strikes and dumps go wrong,
We clean it up and move along.
With logs and care, we try anew—
ETL’s work, both strong and true!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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: 0

🧹 Nitpick comments (1)

hivemind_etl/mediawiki/etl.py (1)

37-44: Good addition of error handling for incomplete file cleanup.

The added try-except block properly handles errors during the crawling process and cleans up any incomplete files that might be left behind. This is a good defensive programming practice.

A few suggestions to consider:

1. You might want to catch more specific exceptions if you know what types of errors can occur during crawling, rather than catching all exceptions with Exception.
2. Consider adding a debug log before deleting the directory that includes the path being removed for easier troubleshooting.

try:
    self.wikiteam_crawler.crawl(api_url, dump_dir)
- except Exception as e:
+ except (IOError, ConnectionError, Exception) as e:  # Be more specific if possible
    logging.error(f"Error crawling {api_url}: {e}")
    logging.warning("Removing incomplete dumped data if available!")
    if os.path.exists(dump_dir):
+       logging.debug(f"Removing directory: {dump_dir}")
        shutil.rmtree(dump_dir)
    raise e

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68050a9 and af15793.

📒 Files selected for processing (1)

• hivemind_etl/mediawiki/etl.py (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

hivemind_etl/mediawiki/etl.py (1)

hivemind_etl/mediawiki/wikiteam_crawler.py (1)

• crawl (26-72)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: ci / test / Test
• GitHub Check: ci / lint / Lint