fix(store): Fix allowed pruning height logic when changing snapshot-interval
#23639
Conversation
📝 WalkthroughWalkthroughThe pull request updates the changelog with an entry for a fix addressing the allowed pruning height logic when the snapshot-interval is changed. In addition, it refactors the Manager’s methods in the pruning package. The HandleSnapshotHeight method now only adds the height if the record is empty or updates the first element if the current height is greater, while GetPruningHeight now calculates the next snapshot height by rounding up the current height to the nearest multiple of the snapshot interval. Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant M as Manager
C->>M: Call HandleSnapshotHeight(height)
alt pruneSnapshotHeights is empty
M->>M: Append current height
else
M->>M: Compare current height with first stored height
alt current height > stored height
M->>M: Update first stored height with current height
end
end
C->>M: Call GetPruningHeight(height)
M->>M: Round up height to nearest multiple of snapshot interval
M-->>C: Return calculated pruning height
Assessment against linked issues
Suggested reviewers
✨ Finishing Touches
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
store/pruning/manager.go (1)
129-130: Enhance the comment to explain the calculation logic.While the implementation is correct, the comment could better explain how the next snapshot height is calculated using integer division and multiplication.
- // so we can prune up to the next upcoming snapshot - 1. + // Calculate next snapshot height by rounding up current height to next multiple of snapshot interval, + // then subtract 1 to get the maximum height we can prune up to.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
store/CHANGELOG.md(1 hunks)store/pruning/manager.go(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.md`: "Assess the documentation for misspellings, gramm...
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
store/CHANGELOG.md
`**/*.go`: Review the Golang code for conformity with the Ub...
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
store/pruning/manager.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (3)
store/pruning/manager.go (2)
70-135: Add unit tests for the modified pruning logic.The changes to
HandleSnapshotHeightandGetPruningHeightneed test coverage, especially for edge cases when snapshot interval changes.Would you like me to help generate comprehensive unit tests for these scenarios:
- Basic snapshot height tracking
- Snapshot interval changes
- Concurrent access patterns
- Edge cases (zero/negative heights, interval changes)
79-87: LGTM! The simplified snapshot height tracking logic looks correct.The implementation properly maintains thread safety and only tracks the latest snapshot height, which aligns with the PR objectives.
Let's verify the thread safety of the snapshot height updates:
✅ Verification successful
🏁 Script executed:
#!/bin/bash # Search for all mutex-protected accesses to pruneSnapshotHeights rg -A 2 "pruneSnapshotHeightsMx\." store/pruning/Length of output: 772
LGTM! The mutex usage around pruneSnapshotHeights confirms that the snapshot height updates are thread-safe.
- Verified that m.pruneSnapshotHeightsMx is properly locked and unlocked during both read and write operations.
store/CHANGELOG.md (1)
34-34: LGTM! Changelog entry follows the guidelines.The entry is properly formatted, concise, and clearly describes the fix.
Description
Closes: #23638
GetPruningHeightfunction. (keep it as an array to prevent breaking change on storage)pruneSnapshotHeights[1:].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...
!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
Documentation
Bug Fixes