Skip to content

fix VersionManager not using CRAWL4_AI_BASE_DIRECTORY #1296

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

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
    • The application now supports customizing its base directory via the CRAWL4_AI_BASE_DIRECTORY environment variable. If not set, it defaults to the user's home directory.

Copy link
Contributor

coderabbitai bot commented Jul 12, 2025

Walkthrough

The constructor of the VersionManager class in crawl4ai/utils.py was updated to determine its home_dir attribute based on the CRAWL4_AI_BASE_DIRECTORY environment variable if present, or else default to the user's home directory. The previous behavior always appended .crawl4ai to the user's home directory.

Changes

File(s) Change Summary
crawl4ai/utils.py Modified VersionManager.__init__ to set home_dir from CRAWL4_AI_BASE_DIRECTORY env var or fallback to user's home directory. Removed automatic appending of .crawl4ai subdirectory.

Poem

A rabbit hopped through code today,
Adjusting where its files would stay.
No more ".crawl4ai" in tow—
The path now bends where env vars go!
Home is where the config's set,
In burrows new, the code is met.
🐇✨

✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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