Skip to content

Conversation

@yihuang
Copy link
Contributor

@yihuang yihuang commented Apr 2, 2025

When consolidate minimal version between memiavl and versiondb, we expect memiavl to load up to the target version, rather than exact target version.

👮🏻👮🏻👮🏻 !!!! 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

    • Added a new configuration option to optimize asynchronous commit processing.
  • Improvements

    • Enhanced version loading to allow flexible matching without strict exactness.
    • Refined synchronization handling to automatically adjust target values for smoother data operations.

@yihuang yihuang requested a review from a team as a code owner April 2, 2025 02:40
@yihuang yihuang requested review from JayT106 and mmsqe and removed request for a team April 2, 2025 02:40
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

This pull request updates the memiavl component by changing the version loading behavior and modifying the WAL catch-up logic. The CHANGELOG now documents that the LoadVersion method loads up to the target version rather than an exact match. A new configuration parameter, 'async-commit-buffer': 5, has been added to the memiavl settings for validators. Additionally, the CatchupWAL method in memiavl has been refactored to compute the end index conditionally and to cap it at the latest available index instead of returning an error.

Changes

Files Summary of Changes
CHANGELOG.md
integration_tests/configs/default.jsonnet
Added a changelog entry referencing PR #1780 regarding improvements in memiavl behavior and introduced a new config parameter (async-commit-buffer: 5).
memiavl/multitree.go Refactored the CatchupWAL method: now applies a conditional check based on endVersion to compute endIndex using walIndex, and caps endIndex to lastIndex instead of erroring when exceeded.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant MultiTree
    participant walIndex

    Caller->>MultiTree: Invoke CatchupWAL(lastIndex, endVersion, initialVersion)
    alt endVersion equals 0
        MultiTree->>Caller: Set endIndex to lastIndex
    else
        MultiTree->>walIndex: Compute endIndex using (endVersion, initialVersion)
        walIndex-->>MultiTree: Return computed endIndex
    end
    alt computed endIndex > lastIndex
        MultiTree->>Caller: Cap endIndex to lastIndex and return
    else
        MultiTree->>Caller: Return computed endIndex
    end
Loading

Possibly related PRs

Suggested reviewers

  • mmsqe
  • leejw51crypto

Poem

I'm a hopping rabbit, light on my feet,
Celebrating changes that make our code neat.
From flexible versions to a smoother flow,
Async commits and catch-up now steal the show.
With a twinkle in my eye and a joyful beat,
I nibble on code—oh, isn't it sweet?
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30279ef and e95ea30.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • integration_tests/configs/default.jsonnet (1 hunks)
  • memiavl/multitree.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: integration_tests (gas)
  • GitHub Check: integration_tests (slow)
  • GitHub Check: integration_tests (upgrade)
  • GitHub Check: integration_tests (gov)
  • GitHub Check: integration_tests (ica)
  • GitHub Check: integration_tests (ibc_update_client)
  • GitHub Check: integration_tests (ibc_timeout)
  • GitHub Check: integration_tests (ibc_rly_gas)
  • GitHub Check: unittest
  • GitHub Check: integration_tests (ibc_rly_evm)
  • GitHub Check: integration_tests (ibc)
  • GitHub Check: integration_tests (unmarked)
  • GitHub Check: build (macos-14)
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Run golangci-lint
  • GitHub Check: Analyze (go)
🔇 Additional comments (3)
integration_tests/configs/default.jsonnet (1)

46-46: New memiavl configuration parameter added

The addition of 'async-commit-buffer': 5 configures the buffer size for asynchronous commits in the memiavl component. This change helps control the number of pending commits that can be queued, potentially improving performance during high transaction throughput scenarios.

CHANGELOG.md (1)

20-20: Appropriate changelog entry for the version loading behavior change

The changelog entry correctly describes the improvement to the memiavl LoadVersion method, which now loads up to the target version instead of requiring an exact version match. This provides more flexibility in version management.

memiavl/multitree.go (1)

329-342: Improved version loading flexibility in CatchupWAL

This change enhances the CatchupWAL method to be more flexible in two important ways:

  1. It allows specifying endVersion=0 to catch up to the latest available version in the WAL
  2. It now caps endIndex at lastIndex instead of returning an error when the requested target version is higher than what's available

This makes the function more robust and aligns with the changelog entry about loading up to the target version instead of requiring an exact match.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

When consolidate minimal version between memiavl and versiondb, we
expect memiavl to load up to the target version, rather than exact
target version.

Update CHANGELOG.md

Signed-off-by: yihuang <[email protected]>
yihuang pushed a commit to yihuang/cronos that referenced this pull request Apr 2, 2025
…ain#1780)

When consolidate minimal version between memiavl and versiondb, we
expect memiavl to load up to the target version, rather than exact
target version.

Update CHANGELOG.md

Signed-off-by: yihuang <[email protected]>
@codecov
Copy link

codecov bot commented Apr 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.13%. Comparing base (a3c2f70) to head (e95ea30).
Report is 61 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1780      +/-   ##
==========================================
+ Coverage   16.87%   17.13%   +0.25%     
==========================================
  Files          72       75       +3     
  Lines        6163     6205      +42     
==========================================
+ Hits         1040     1063      +23     
- Misses       5000     5018      +18     
- Partials      123      124       +1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mmsqe added a commit that referenced this pull request Apr 8, 2025
* Problem: memiavl too strict on target version (backport #1780)

When consolidate minimal version between memiavl and versiondb, we
expect memiavl to load up to the target version, rather than exact
target version.

Update CHANGELOG.md

Signed-off-by: yihuang <[email protected]>

* Update CHANGELOG.md

Co-authored-by: yihuang <[email protected]>
Signed-off-by: mmsqe <[email protected]>

---------

Signed-off-by: yihuang <[email protected]>
Signed-off-by: mmsqe <[email protected]>
Co-authored-by: mmsqe <[email protected]>
@yihuang yihuang added this pull request to the merge queue Apr 9, 2025
Merged via the queue into crypto-org-chain:main with commit 3701cc2 Apr 9, 2025
38 checks passed
songgaoye added a commit to crypto-org-chain/chain-main that referenced this pull request Aug 5, 2025
songgaoye added a commit to crypto-org-chain/chain-main that referenced this pull request Aug 5, 2025
songgaoye added a commit to crypto-org-chain/chain-main that referenced this pull request Aug 5, 2025
update memival,store,versondb
related prs
crypto-org-chain/cronos#1684
crypto-org-chain/cronos#1685
crypto-org-chain/cronos#1688
(Do not include versionDB.SetSkipVersionZero(true) in app.go)
crypto-org-chain/cronos#1751
crypto-org-chain/cronos#1759
(note: Do not include cronos storeloader and upgrades)

note:
I don't use this.
crypto-org-chain/cronos#1780
because it update rocksdbs from version 9.2.1 to 9.11.2
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