fix(store/v2): fix the pebbledb storage implementation #21837
Conversation
WalkthroughWalkthroughThe changes in this pull request primarily focus on modifying the functionality of the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
|
@cool-develope your pull request is missing a changelog! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (3)
- store/v2/storage/pebbledb/db.go (3 hunks)
- store/v2/storage/pebbledb/iterator.go (1 hunks)
- store/v2/storage/storage_test_suite.go (1 hunks)
Additional context used
Path-based instructions (3)
store/v2/storage/pebbledb/db.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.store/v2/storage/pebbledb/iterator.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.store/v2/storage/storage_test_suite.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (6)
store/v2/storage/pebbledb/iterator.go (1)
85-90: LGTM! The added check improves the iterator's behavior by skipping tombstoned entries.The new condition
itr.valid && itr.cursorTombstoned()ensures that if the iterator is valid but currently pointing to a tombstoned key/value pair, it advances to the next non-tombstoned entry usingitr.Next().This enhancement prevents the iterator from remaining stuck on deleted entries, thereby improving the integrity of the data being iterated over.
store/v2/storage/storage_test_suite.go (1)
488-513: LGTM!The test function is well-structured and covers the expected behavior of the database iterator when a key is deleted. It follows the AAA pattern and uses helper functions to improve readability. The test naming is also consistent with the convention.
store/v2/storage/pebbledb/db.go (4)
71-73: Update to usegetEarliestVersionfunction is appropriateThe change to retrieve the earliest version using
getEarliestVersion(db)improves the initialization logic by accurately reflecting the earliest version available in the database.
78-78: Properly initializingearliestVersionfieldSetting the
earliestVersionduring database initialization ensures correct tracking of the earliest version and helps prevent potential inconsistencies.
84-86: Consistent retrieval ofearliestVersioninNewWithDBThe update to retrieve
earliestVersionin theNewWithDBfunction and handling errors appropriately maintains consistency with theNewfunction.Also applies to: 91-91
383-383: Confirm the logic of incrementingpruneHeightby 1In
getEarliestVersion, adding 1 tobinary.LittleEndian.Uint64(bz)calculates theearliestVersionbased onpruneHeight + 1. Please verify that this logic aligns with the expected behavior, especially in scenarios where thepruneHeightis unset or zero, to avoid off-by-one errors.
| // getEarliestVersion returns the earliest version set in the database. | ||
| // It is calculated by prune height + 1. If the prune height is not set, it | ||
| // returns 0. | ||
| func getEarliestVersion(storage *pebble.DB) (uint64, error) { |
There was a problem hiding this comment.
Refine the documentation comment for getEarliestVersion
The documentation comment can be improved to adhere to Go's documentation conventions:
- Start with the function name.
- Use complete sentences.
- Enclose variable names in backticks for clarity.
Apply this diff to enhance the comment:
-// getEarliestVersion returns the earliest version set in the database.
-// It is calculated by prune height + 1. If the prune height is not set, it
-// returns 0.
+// getEarliestVersion returns the earliest version set in the database.
+// It is calculated by adding 1 to the `pruneHeight`. If the `pruneHeight` is not set, it returns 0.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // getEarliestVersion returns the earliest version set in the database. | |
| // It is calculated by prune height + 1. If the prune height is not set, it | |
| // returns 0. | |
| func getEarliestVersion(storage *pebble.DB) (uint64, error) { | |
| // getEarliestVersion returns the earliest version set in the database. | |
| // It is calculated by adding 1 to the `pruneHeight`. If the `pruneHeight` is not set, it returns 0. | |
| func getEarliestVersion(storage *pebble.DB) (uint64, error) { |
|
Description
Closes: #21642
While debugging it, found two following issues.
earliestVersionfrom 1 initially to 0Author 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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
New Features
Bug Fixes