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

feat(store/v2): support rocks out of the box #21649

Merged
merged 5 commits into from
Sep 11, 2024
Merged

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Sep 11, 2024

Description

support rocksdb out of the box


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced support for RocksDB as a valid storage option, enhancing the root store creation capabilities.
    • Added a new database interface for RocksDB, allowing for future integration while currently preventing operations without the appropriate build flag.
  • Bug Fixes

    • Resolved the issue where RocksDB was previously unsupported, now enabling its functionality.
  • Documentation

    • Updated configuration documentation to reflect the new RocksDB storage option and its requirements.

@tac0turtle tac0turtle marked this pull request as ready for review September 11, 2024 09:27
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

The changes introduce support for RocksDB in the CreateRootStore function within the factory.go file. A new file, db_noflag.go, is added to define a Database struct that implements necessary interfaces for RocksDB, although its methods are designed to panic unless specific build flags are set. This implementation allows for the initialization and use of RocksDB as a storage option while ensuring that operations are restricted under certain conditions.

Changes

Files Change Summary
store/v2/root/factory.go Modified CreateRootStore to support RocksDB storage type; added import for RocksDB.
store/v2/storage/rocksdb/db_noflag.go Introduced Database struct implementing storage.Database and store.UpgradableDatabase interfaces; methods panic unless build flags are enabled.
server/v2/testdata/app.toml Updated comment in configuration file to include "rocksdb" as a supported storage option alongside "sqlite" and "pebble".

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Factory
    participant RocksDB

    Client->>Factory: Request CreateRootStore
    Factory->>RocksDB: Initialize RocksDB
    RocksDB-->>Factory: Return Database instance
    Factory-->>Client: Return RootStore instance
Loading

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 19b0c9a and a6ef793.

Files selected for processing (2)
  • server/v2/testdata/app.toml (1 hunks)
  • store/v2/root/factory.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • store/v2/root/factory.go
Additional comments not posted (1)
server/v2/testdata/app.toml (1)

28-28: LGTM!

The comment change is approved. It accurately reflects the addition of "rocksdb" as a supported storage database type.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.

@tac0turtle
Copy link
Member Author

blocked on #21645

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

utACK

@github-actions github-actions bot added the C:server/v2 Issues related to server/v2 label Sep 11, 2024
@julienrbrt julienrbrt changed the title chore: support rocks out of the box feat(store/v2): support rocks out of the box Sep 11, 2024
@tac0turtle tac0turtle added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit 72620a5 Sep 11, 2024
76 of 77 checks passed
@tac0turtle tac0turtle deleted the marko/addrocksdb-SS branch September 11, 2024 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:server/v2 Issues related to server/v2 C:Store
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants