Skip to content

Conversation

vladmandic
Copy link

@vladmandic vladmandic commented Jul 12, 2025

Summary

VersionManager did not do an eval of CRAWL4_AI_BASE_DIRECTORY env variable unlike actual database manager,
so it caused split-brain scenario where database was written in folder specified by env variable,
followed by failure to write version.txt since that was force-attempted in users home folder.

List of files changed and why

utils.py:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added/updated unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features
    • You can now customize the application's base directory with the CRAWL4_AI_BASE_DIRECTORY environment variable; if unset it defaults to the user's home directory.
    • Version tracking file is now stored directly in that base directory (no hidden subdirectory), ensuring predictable location for version information.

Copy link
Contributor

coderabbitai bot commented Jul 12, 2025

Walkthrough

The VersionManager constructor in crawl4ai/utils.py now sets home_dir from the CRAWL4_AI_BASE_DIRECTORY environment variable (if present) or else uses the user's home directory. It no longer appends a .crawl4ai subdirectory; version_file is located at home_dir / "version.txt".

Changes

Cohort / File(s) Change Summary
VersionManager change
crawl4ai/utils.py
Updated VersionManager.__init__ to derive self.home_dir from os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()) instead of Path.home() / ".crawl4ai". version_file now points to home_dir / "version.txt" (removed implicit .crawl4ai subdirectory).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit hopped through code today,
It nudged the path to find its way.
No dot-folder trailing behind—
The env decides the burrow kind.
🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 83b323f and 367190f.

📒 Files selected for processing (1)
  • crawl4ai/utils.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • crawl4ai/utils.py
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link
Contributor

@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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
crawl4ai/utils.py (1)

229-229: ✅ Good fix for the split-brain scenario, but consider type consistency.

This change correctly addresses the issue where VersionManager wasn't respecting the CRAWL4_AI_BASE_DIRECTORY environment variable. However, there's a minor type inconsistency in the implementation.

The current implementation mixes types: os.getenv() returns a string when the environment variable is set, but Path.home() returns a Path object when it's not set. While the Path() constructor handles both, it's cleaner to be consistent:

-self.home_dir = Path(os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()))
+self.home_dir = Path(os.getenv("CRAWL4_AI_BASE_DIRECTORY") or Path.home())

or

-self.home_dir = Path(os.getenv("CRAWL4_AI_BASE_DIRECTORY", Path.home()))
+self.home_dir = Path(os.getenv("CRAWL4_AI_BASE_DIRECTORY", str(Path.home())))
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bde1bba and 83b323f.

📒 Files selected for processing (1)
  • crawl4ai/utils.py (1 hunks)

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.

1 participant