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

Problem: rocksdb wal format sometimes not backward compatible #1379

Merged
merged 2 commits into from
Apr 9, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Apr 9, 2024

Solution:

  • flush the wal before quit the node, make the rocksdb upgrade smooth.

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features
    • Improved the graceful shutdown process to smoothly upgrade the database by flushing the version database.
  • Refactor
    • Updated application structure and database handling methods to support efficient database flushing and upgrades.
  • Documentation
    • Added methods and structures for flushing the version database during graceful shutdown and upgrades.

@yihuang yihuang requested a review from a team as a code owner April 9, 2024 03:33
@yihuang yihuang requested review from leejw51crypto, thomas-nguy and mmsqe and removed request for a team April 9, 2024 03:33
Copy link
Contributor

coderabbitai bot commented Apr 9, 2024

Warning

Rate Limit Exceeded

@yihuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 26 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between a4ea449 and c9acc3e.

Walkthrough

The recent upgrade introduces a crucial improvement for a smoother RocksDB upgrade process by implementing a flush mechanism across various components to ensure data integrity and compatibility during graceful shutdowns.

Changes

File Path Change Summary
app/app.go Modified to support qms field, updated import, and enhanced Close method.
versiondb/... (Multiple Files) Introduced Flush methods in MultiStore, Store, and VersionStore for data persistence during upgrades.

🐰✨
In the realm of code, where data flows free,
A rabbit hopped in, with changes to see.
"Flush and close," it whispered with glee,
For smoother upgrades, as smooth as can be.
🌟📚
With every hop, a fix, a new feature to tout,
Ensuring the database, inside and out.
🐾🥕

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.

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

CHANGELOG.md Outdated Show resolved Hide resolved
@yihuang
Copy link
Collaborator Author

yihuang commented Apr 9, 2024

need to verify in #1378

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.

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1aea999 and 6d1cfd6.
Files selected for processing (5)
  • CHANGELOG.md (1 hunks)
  • app/app.go (5 hunks)
  • versiondb/multistore.go (1 hunks)
  • versiondb/tsrocksdb/store.go (1 hunks)
  • versiondb/types.go (1 hunks)
Additional comments not posted (7)
versiondb/types.go (1)

25-27: Adding the Flush() method to the VersionStore interface is a crucial step for ensuring data persistence during RocksDB upgrades. Please ensure that all implementations of VersionStore provide a meaningful implementation of this method.

versiondb/multistore.go (1)

149-152: The addition of the Close method to the MultiStore struct is well-implemented. Please ensure that this method is properly invoked during the application's shutdown sequence to guarantee the flushing of the version database.

versiondb/tsrocksdb/store.go (1)

208-213: The implementation of the Flush method in the Store struct is well-done, ensuring that the database is flushed using appropriate options. Consider documenting the expected errors this method might encounter and how implementers should handle them.

app/app.go (4)

372-373: Consider documenting the purpose of qms storetypes.MultiStore within the App struct.

Adding comments explaining the purpose and usage of newly introduced fields can significantly improve code readability and maintainability.


866-866: Ensure proper error handling for setupVersionDB.

It's crucial to ensure that any errors returned by setupVersionDB are handled appropriately to prevent runtime panics or unintended behavior.


903-905: Validate the logic for preventing version gaps between versiondb and iavl.

Ensuring that there are no version gaps between versiondb and iavl is critical for data consistency. It's important to validate that this logic correctly handles all edge cases.

Verification successful

The script output confirms the presence of logic in app/app.go designed to prevent version gaps between versiondb and iavl by comparing their versions and exiting if versiondb lags behind iavl. This aligns with the initial concern for ensuring data consistency by handling version gaps appropriately.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify the logic for preventing version gaps between versiondb and iavl.
rg "versiondb version"

Length of output: 216


1200-1212: Ensure comprehensive error handling in the Close method.

When aggregating errors in the Close method, consider using a more robust error handling strategy to log or handle each error individually. This approach can provide more clarity on which components failed during the shutdown process.

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented Apr 9, 2024

Codecov Report

Attention: Patch coverage is 0% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 36.51%. Comparing base (5c31fe0) to head (c9acc3e).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1379       +/-   ##
===========================================
+ Coverage   16.47%   36.51%   +20.04%     
===========================================
  Files          80      129       +49     
  Lines        5124     9606     +4482     
===========================================
+ Hits          844     3508     +2664     
- Misses       4204     5721     +1517     
- Partials       76      377      +301     
Files Coverage Δ
versiondb/multistore.go 0.00% <0.00%> (ø)
versiondb/tsrocksdb/store.go 54.05% <0.00%> (ø)

... and 71 files with indirect coverage 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.

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6d1cfd6 and 62fc8b5.
Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Additional comments not posted (1)
CHANGELOG.md (1)

7-7: Consider capitalizing "versiondb" and "rocksdb" to "VersionDB" and "RocksDB" respectively for consistency with technical naming conventions.

Solution:
- flush the wal before quit the node, make the rocksdb upgrade smooth.

Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

fix flush
Signed-off-by: yihuang <huang@crypto.com>
@yihuang
Copy link
Collaborator Author

yihuang commented Apr 9, 2024

it works @mmsqe

@yihuang yihuang enabled auto-merge April 9, 2024 07:24
@yihuang yihuang added this pull request to the merge queue Apr 9, 2024
Merged via the queue into crypto-org-chain:main with commit 58ce7f4 Apr 9, 2024
44 of 45 checks passed
yihuang added a commit to yihuang/cronos that referenced this pull request Apr 9, 2024
crypto-org-chain#1379)

Solution:
- flush the wal before quit the node, make the rocksdb upgrade smooth.

Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

fix flush

Signed-off-by: yihuang <huang@crypto.com>
@yihuang yihuang deleted the flush-rocksdb branch April 9, 2024 08:32
yihuang added a commit that referenced this pull request Apr 9, 2024
#1379) (#1382)

Solution:
- flush the wal before quit the node, make the rocksdb upgrade smooth.

Update CHANGELOG.md



fix flush

Signed-off-by: yihuang <huang@crypto.com>
yihuang added a commit that referenced this pull request Apr 9, 2024
* Problem: cosmovisor in test is out dated (#1380)

new version cosmovisor support graceful shutdown

Solution:
- update cosmovisor
- adapt the test case

Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

* Problem: rocksdb wal format sometimes not backward compatible (#1379)

Solution:
- flush the wal before quit the node, make the rocksdb upgrade smooth.

Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

fix flush

Signed-off-by: yihuang <huang@crypto.com>

* Problem: upgrade test nix package is incorrect (#1384)

---------

Signed-off-by: yihuang <huang@crypto.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants