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

Use one global DB client instead of one for each pipeline #171

Merged
merged 3 commits into from
Nov 27, 2024

Conversation

Hialus
Copy link
Member

@Hialus Hialus commented Nov 11, 2024

Summary by CodeRabbit

  • New Features

    • Improved management of the Weaviate client connection for enhanced performance.
  • Bug Fixes

    • Simplified the cleanup behavior of the VectorDatabase class.

@Hialus Hialus requested review from bassner and yassinsws November 11, 2024 01:02
@Hialus Hialus self-assigned this Nov 11, 2024
Copy link
Contributor

coderabbitai bot commented Nov 11, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on the VectorDatabase class within the app/vector_database/database.py file. A new class-level variable _lock is introduced to ensure thread-safe access to the Weaviate client instance, alongside a _client_instance variable to hold the singleton instance of the client. The constructor is updated to implement a thread-safe mechanism for initializing the Weaviate client. The destructor method has been removed, simplifying the class structure for client instance management and thread safety.

Changes

File Path Change Summary
app/vector_database/database.py Added class-level variable _lock for thread safety; added _client_instance for singleton client management; updated __init__ method for thread-safe client initialization; removed __del__ method.

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

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: 2

🧹 Outside diff range and nitpick comments (2)
app/vector_database/database.py (2)

9-10: Improve global variable declaration.

The global variable should be properly scoped and documented:

  1. Consider moving it inside the class as a class variable
  2. Add type hints
  3. Add docstring explaining its purpose
-_weaviate_database_client = None
+class VectorDatabase:
+    """Class to interact with the Weaviate vector database"""
+    
+    # Singleton instance of the Weaviate client
+    _weaviate_database_client: Optional[weaviate.Client] = None

23-32: Consider additional architectural improvements.

For a production-grade database client implementation, consider:

  1. Implement connection pooling for better concurrency handling
  2. Add health checks and automatic reconnection strategy
  3. Add metrics collection for:
    • Connection pool usage
    • Query latency
    • Error rates
  4. Implement circuit breaker pattern for graceful degradation

Would you like me to provide example implementations for any of these improvements?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 326de7e and a85f5d4.

📒 Files selected for processing (1)
  • app/vector_database/database.py (1 hunks)

yassinsws
yassinsws previously approved these changes Nov 11, 2024
Copy link
Contributor

@yassinsws yassinsws left a comment

Choose a reason for hiding this comment

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

changes look good

@ls1intum ls1intum deleted a comment from coderabbitai bot Nov 27, 2024
@ls1intum ls1intum deleted a comment from coderabbitai bot Nov 27, 2024
@bassner bassner merged commit a23c238 into main Nov 27, 2024
6 checks passed
@bassner bassner deleted the chore/use_global_db_client branch November 27, 2024 19:00
@bassner bassner added this to the 1.1.0 milestone Feb 3, 2025
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.

3 participants