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: versiondb lag behind when os reboot #1304

Merged
merged 4 commits into from
Jan 29, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Jan 26, 2024

Closes: #1301

Solution:

  • do fsync when writing versiondb, this should make versiondb lag at most 1 version behind when OS reboot.
  • relax the version requirement on startup.

see: #1304 (comment), this change should cover most version mismatch cases, the only edge case left can be fixed by the default cronosd rollback command.

👮🏻👮🏻👮🏻 !!!! 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
    • Enhanced database write operations with the addition of synchronous write options for improved data integrity.

Closes: crypto-org-chain#1301

Solution:
- do fsync when writing versiondb
@yihuang yihuang requested a review from a team as a code owner January 26, 2024 09:36
@yihuang yihuang requested review from JayT106 and devashishdxt and removed request for a team January 26, 2024 09:36
Copy link
Contributor

coderabbitai bot commented Jan 26, 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 28 minutes and 42 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 8b40a2c and 052ef9d.

Walkthrough

The changes aim to ensure data integrity by introducing a mechanism to flush data to disk immediately in versiondb. Additionally, the logic in the New function in app.go has been modified to check for version mismatches between qms and app, and the error message has been updated accordingly.

Changes

File Path Change Summary
CHANGELOG.md Added "Write versiondb with fsync"
app/app.go Modified New function to check for version mismatches and update error message
versiondb/tsrocksdb/store.go Introduced defaultSyncWriteOpts and used it in PutAtVersion

Assessment against linked issues

Objective Addressed Explanation
#1301: Ensure versiondb and iavl versions match The modification in app.go ensures that version mismatches between qms and app are checked, contributing to the alignment of versions between versiondb and iavl.
#1301: Improve data integrity and system resilience The addition of fsync in CHANGELOG.md and the use of defaultSyncWriteOpts in store.go enhance data integrity and resilience, addressing concerns over version mismatches and data consistency.

Poem

In the realm where data flows, a rabbit hopped and something glows.
"Fsync!" it cried, with ears so wide, ensuring data won't collide.
Through rocks and trees, in databases' breeze,
It left a trail of sync, with ease. 🐰💾

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

CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: yihuang <huang@crypto.com>
@yihuang yihuang requested a review from mmsqe January 26, 2024 09:37
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: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8fd18dc and 8256c05.
Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • versiondb/tsrocksdb/store.go (2 hunks)
Additional comments: 3
versiondb/tsrocksdb/store.go (2)
  • 29-30: The introduction of defaultSyncWriteOpts with the intention to enable fsync during write operations is a critical change for ensuring data integrity. This approach is aligned with the PR's objective to mitigate the risk of version mismatches after unexpected shutdowns.
  • 34-36: The configuration of defaultSyncWriteOpts in the init function to enable synchronization with the underlying storage using SetSync(true) is correctly implemented. This ensures that every write operation using these options will be followed by an fsync.
CHANGELOG.md (1)
  • 8-8: The addition of the changelog entry "Write versiondb with fsync" effectively communicates the key change introduced in this pull request. It's concise and directly references the core improvement made to the versiondb writes. This entry helps in keeping the project's documentation up to date and provides clear information to the users about the enhancements in data integrity.

versiondb/tsrocksdb/store.go Show resolved Hide resolved
Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8fd18dc) 35.88% compared to head (052ef9d) 35.89%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1304      +/-   ##
==========================================
+ Coverage   35.88%   35.89%   +0.01%     
==========================================
  Files         116      116              
  Lines       10698    10700       +2     
==========================================
+ Hits         3839     3841       +2     
  Misses       6482     6482              
  Partials      377      377              
Files Coverage Δ
versiondb/tsrocksdb/store.go 52.32% <100.00%> (+0.56%) ⬆️

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: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8256c05 and 8b40a2c.
Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • app/app.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md

app/app.go Show resolved Hide resolved
@yihuang yihuang requested a review from mmsqe January 26, 2024 11:39
@yihuang yihuang added this pull request to the merge queue Jan 29, 2024
Merged via the queue into crypto-org-chain:main with commit 12efd9b Jan 29, 2024
44 checks passed
@yihuang yihuang deleted the sync-versiondb branch January 29, 2024 04:30
mmsqe pushed a commit to mmsqe/cronos that referenced this pull request Jan 30, 2024
* Problem: versiondb lag behind when os reboot

Closes: crypto-org-chain#1301

Solution:
- do fsync when writing versiondb

* Update CHANGELOG.md

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

* relax version checking

* changelog

---------

Signed-off-by: yihuang <huang@crypto.com>
mmsqe pushed a commit to mmsqe/cronos that referenced this pull request Jan 30, 2024
* Problem: versiondb lag behind when os reboot

Closes: crypto-org-chain#1301

Solution:
- do fsync when writing versiondb

* Update CHANGELOG.md

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

* relax version checking

* changelog

---------

Signed-off-by: yihuang <huang@crypto.com>
mmsqe added a commit that referenced this pull request Jan 30, 2024
…1306)

* Problem: memiavl rootmulti store access map concurrently (#1302)

* Problem: memiavl rootmulti store access map concurrently

Solution:
- code refactoring

* Update CHANGELOG.md

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

---------

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

* mod tidy

* Problem: versiondb lag behind when os reboot (#1304)

* Problem: versiondb lag behind when os reboot

Closes: #1301

Solution:
- do fsync when writing versiondb

* Update CHANGELOG.md

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

* relax version checking

* changelog

---------

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

* fix lint

---------

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

Successfully merging this pull request may close these issues.

versiondb lastest version don't match iavl latest version
3 participants