feat: allow user to provide client for OpenSearchVectorDatabase

[dandeto]

I made two small commits. The first adds a constructor so that a user can pass in a preconfigured OpenSearchClient. This allows users to us other configurations instead of being forced to use simple authentication for OpenSearch.

The second commit simply changes all references to OpenSearchClient to the interface IOpenSearchClient for greater flexibility. If this is not desired for some reason, I can undo it.

I am working on an application that would benefit from these changes.

Summary by CodeRabbit

• Refactor
  • Updated the client integration to use a more flexible interface, which enhances overall integration options and improves testability while maintaining existing functionality.

[coderabbitai]

Walkthrough

The changes update the client dependency in two OpenSearch classes. In the OpenSearchVectorCollection class, the constructor parameter type is switched from a concrete OpenSearchClient to the interface IOpenSearchClient. In the OpenSearchVectorDatabase class, the private field _client is similarly updated to IOpenSearchClient, and a new constructor that accepts an IOpenSearchClient instance is added. These modifications are aimed at enabling dependency injection and increasing flexibility without altering the classes’ core functionalities.

Changes

File(s)	Change Summary
src/OpenSearch/...VectorCollection.cs	Constructor parameter type changed from OpenSearchClient to IOpenSearchClient.
src/OpenSearch/...VectorDatabase.cs	Updated _client field type from OpenSearchClient to IOpenSearchClient; added new constructor accepting an IOpenSearchClient instance.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VectorDB as OpenSearchVectorDatabase
    participant VectorCol as OpenSearchVectorCollection
    participant IClient as IOpenSearchClient

    User->>VectorDB: new(IClient client)
    Note right of VectorDB: Sets _client field via dependency injection
    User->>VectorCol: new(IClient client)
    Note right of VectorCol: Injected client dependency for operations

Loading

Poem

I hop through code with joyful glee,
Changing clients so gracefully.
Interfaces now lead the way,
Making testing light as day.
With each hop, bugs scurry away,
CodeRabbit cheers on this bright display!
🐇💻

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 83cc8ca and 6e02b7a.

📒 Files selected for processing (2)

• src/OpenSearch/src/OpenSearchVectorCollection.cs (1 hunks)
• src/OpenSearch/src/OpenSearchVectorDatabase.cs (2 hunks)

🔇 Additional comments (3)

src/OpenSearch/src/OpenSearchVectorCollection.cs (1)

10-10: Good change to use interface instead of concrete implementation

Changing the parameter type from OpenSearchClient to IOpenSearchClient improves the class's flexibility and testability through proper dependency injection. This change follows good software engineering practices by reducing coupling to concrete implementations.

src/OpenSearch/src/OpenSearchVectorDatabase.cs (2)

10-10: Good refactoring to use interface for the client field

Changing the field type from OpenSearchClient to IOpenSearchClient is a good practice that allows for more flexibility in the implementation. This change aligns with the dependency inversion principle and makes the class more testable.

---

28-35: Well-implemented constructor for dependency injection

This new constructor is a valuable addition that enables users to provide their own pre-configured IOpenSearchClient instances. It's properly documented with XML comments and maintains a clean implementation. This change enhances flexibility while preserving backward compatibility.

✨ 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 plan to trigger planning for file edits and PR creation.
• @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.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}