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 rocksdb and pebbledb as RawDB #19607

Merged
merged 31 commits into from
Mar 19, 2024
Merged

Conversation

alexanderbez
Copy link
Contributor

@alexanderbez alexanderbez commented Feb 29, 2024

Description

Closes: #19606

This PR introduces support for PebbleDB and RocksDB as backing implementations of RawDB which is used to perform a migration from store/v1 to store/v2.


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

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 RocksDB as a new storage engine option, enhancing data storage and retrieval capabilities.
    • Added support for key-value operations, iteration, and batch processing with RocksDB, aiming at performance improvement.

Copy link
Contributor

coderabbitai bot commented Feb 29, 2024

Walkthrough

Walkthrough

The introduced changes focus on implementing RawDB functionality using RocksDB as the storage engine. This enhancement is aimed at supporting snapshot management and commitment store beyond the existing goleveldb implementation, with specific attention to migrating iavlv1 store to accommodate users of PebbleDB and RocksDB.

Changes

File(s) Change Summary
store/db/rocksdb.go Introduces RocksDB-based RawDB implementation, including basic operations and batch management.
store/db/rocksdb_noflag.go Adds RocksDB as a storage engine for store v2 migration, detailing database operation methods.

Assessment against linked issues

Objective Addressed Explanation
Implement rawdb for PebbleDB and RocksDB for snapshot manager and commitment store (#19606)
Migrate iavlv1 store using rawdb implemented for PebbleDB and RocksDB (#19606) While the changes clearly support RocksDB, there's no explicit mention of PebbleDB or the specific mechanisms used for the migration of iavlv1 store.

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

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@alexanderbez alexanderbez marked this pull request as ready for review March 1, 2024 22:12
@alexanderbez alexanderbez requested a review from a team as a code owner March 1, 2024 22:12
Copy link
Contributor

github-actions bot commented Mar 1, 2024

@alexanderbez your pull request is missing a changelog!

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.

Review Status

Actionable comments generated: 6

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 1c9361c and 6e39577.
Files selected for processing (6)
  • store/db/db_test.go (2 hunks)
  • store/db/goleveldb.go (1 hunks)
  • store/db/pebbledb.go (1 hunks)
  • store/db/rocksdb.go (1 hunks)
  • store/go.mod (1 hunks)
  • store/go.sum (1 hunks)
Additional comments: 8
store/db/db_test.go (3)
  • 19-21: The addition of the TearDownSuite method for closing the database connection after tests is a good practice for resource cleanup.
  • 100-107: The TestPebbleDBSuite function correctly initializes a PebbleDB instance for testing, using a temporary directory for isolation.
  • 109-116: The TestRocksDBSuite function correctly initializes a RocksDB instance for testing, using a temporary directory for isolation.
store/go.mod (1)
  • 13-13: The update of the github.com/cosmos/iavl dependency to v1.1.0 is noted. Ensure that this version's changes are compatible with the project's requirements and that all tests pass.
store/db/pebbledb.go (1)
  • 44-70: The Close, Get, and Has methods are correctly implemented and follow best practices for resource management and error handling.
store/db/rocksdb.go (1)
  • 54-67: The Close, Get, and Has methods are correctly implemented and follow best practices for resource management and error handling.
store/db/goleveldb.go (1)
  • 20-20: Explicitly declaring GoLevelDB as an implementation of store.RawDB is a good practice for clarity and ensures that GoLevelDB adheres to the store.RawDB interface. This change enhances code readability and maintainability.
store/go.sum (1)
  • 49-50: The update of github.com/cosmos/iavl from v1.0.0-beta.1.0.20240125174944-11ba4961dae9 to v1.1.0 is noted. Ensure that this version bump is compatible with the rest of the project's dependencies and does not introduce breaking changes that could affect the project's stability or functionality.

store/db/goleveldb.go Outdated Show resolved Hide resolved
store/db/pebbledb.go Outdated Show resolved Hide resolved
store/db/pebbledb.go Outdated Show resolved Hide resolved
store/db/rocksdb.go Outdated Show resolved Hide resolved
store/db/rocksdb.go Outdated Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 6e39577 and 19942b0.
Files selected for processing (2)
  • store/go.mod (1 hunks)
  • store/go.sum (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • store/go.mod
  • store/go.sum

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

there needs to be a global NewDB func like we have in cosmos-db to avoid needing to make this at a higher level for iavl. its better to house all the logic for store here instead of consumers needing to create wrappers left and right

@tac0turtle tac0turtle dismissed stale reviews from testinginprod, cool-develope, and themself March 18, 2024 11:20

dismissing due to changes

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.

Review Status

Actionable comments generated: 6

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 008bb7a and 4cb9223.
Files selected for processing (4)
  • store/db/goleveldb.go (1 hunks)
  • store/db/pebbledb.go (1 hunks)
  • store/db/rocksdb.go (1 hunks)
  • store/db/rocksdb_noflag.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • store/db/goleveldb.go
  • store/db/pebbledb.go
  • store/db/rocksdb.go
Additional comments: 1
store/db/rocksdb_noflag.go (1)
  • 1-2: The use of both //go:build !rocksdb and // +build !rocksdb directives for conditional compilation is correct and follows best practices. This ensures compatibility with both older and newer versions of Go. However, it's important to note that the // +build directive is deprecated in favor of //go:build in Go 1.17 and later. If support for Go versions before 1.17 is not required, consider removing the // +build directive.

store/db/rocksdb_noflag.go Show resolved Hide resolved
store/db/rocksdb_noflag.go Show resolved Hide resolved
store/db/rocksdb_noflag.go Show resolved Hide resolved
store/db/rocksdb_noflag.go Show resolved Hide resolved
store/db/rocksdb_noflag.go Show resolved Hide resolved
store/db/rocksdb_noflag.go Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 4cb9223 and 0f76ba8.
Files selected for processing (4)
  • store/db/db.go (1 hunks)
  • store/db/goleveldb.go (2 hunks)
  • store/db/pebbledb.go (1 hunks)
  • store/db/rocksdb.go (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • store/db/db.go
  • store/db/goleveldb.go
  • store/db/pebbledb.go
  • store/db/rocksdb.go

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 0f76ba8 and 29bf2df.
Files selected for processing (1)
  • store/db/rocksdb.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • store/db/rocksdb.go

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 29bf2df and 61b88c6.
Files selected for processing (5)
  • store/db/db_test.go (2 hunks)
  • store/db/rocksdb.go (1 hunks)
  • store/db/rocksdb_noflag.go (1 hunks)
  • store/go.mod (1 hunks)
  • store/go.sum (1 hunks)
Files skipped from review as they are similar to previous changes (5)
  • store/db/db_test.go
  • store/db/rocksdb.go
  • store/db/rocksdb_noflag.go
  • store/go.mod
  • store/go.sum

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 61b88c6 and b94a471.
Files selected for processing (2)
  • store/db/rocksdb.go (1 hunks)
  • store/db/rocksdb_noflag.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • store/db/rocksdb.go
  • store/db/rocksdb_noflag.go

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between b94a471 and efbe831.
Files selected for processing (1)
  • store/db/rocksdb.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • store/db/rocksdb.go

store/db/rocksdb_noflag.go Dismissed Show dismissed Hide dismissed
store/db/rocksdb_noflag.go Dismissed Show dismissed Hide dismissed
store/db/rocksdb_noflag.go Dismissed Show dismissed Hide dismissed
store/db/rocksdb_noflag.go Dismissed Show dismissed Hide dismissed
store/db/rocksdb_noflag.go Dismissed Show dismissed Hide dismissed
store/db/rocksdb_noflag.go Dismissed Show dismissed Hide dismissed
}

func (b *rocksDBBatch) Close() error {
panic("rocksdb must be built with -tags rocksdb")

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods Warning

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
@tac0turtle tac0turtle added this pull request to the merge queue Mar 19, 2024
Merged via the queue into main with commit a86c2a9 Mar 19, 2024
62 of 63 checks passed
@tac0turtle tac0turtle deleted the bez/19606 branch March 19, 2024 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature](store): implement rawdb pebbledb and rocks db
6 participants