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: need run fixdata multiple times when no timestamp checking #1748

Merged
merged 3 commits into from
Feb 18, 2025

Conversation

mmsqe
Copy link
Collaborator

@mmsqe mmsqe commented Feb 17, 2025

query with GetCFWithTS to compare both timestamp and key

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

  • Bug Fixes
    • Resolved performance and deadlock issues affecting system operations.
    • Improved transaction reliability by addressing batch processing errors.
  • Improvements
    • Enhanced efficiency during simulation runs by streamlining batch handling.
    • Upgraded data consistency checks to bolster overall data integrity.

query with GetCFWithTS to compare both timestamp and key
Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

Walkthrough

This pull request updates the CHANGELOG.md with new bug fixes and improvements, and modifies the fixDataStore method in the versioned TS RocksDB store. The changelog now includes entries addressing performance regressions and deadlocks in the iavl module, nonce management in the ethermint module, and a control flow change for the dry-run option during fixdata execution. In the store, the retrieval of data now fetches both the old value and its timestamp, with the comparison logic adjusted accordingly.

Changes

File(s) Change Summary
CHANGELOG.md Added new bug fix entries for performance regression issues and deadlock in the iavl module, and for nonce management in the ethermint module. Added a new improvement for dry-run batch handling. Removed a previous improvement entry from the v1.4.1 section.
versiondb/tsrocksdb/store.go Modified the fixDataStore method to retrieve both the old value and its timestamp using GetCFWithTS. Updated the comparison logic to include a timestamp check and freed associated memory.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FixDataHandler
    participant BatchManager
    participant Database

    User->>FixDataHandler: Invoke fixdata with dry-run
    FixDataHandler->>BatchManager: Check dry-run option
    BatchManager-->>FixDataHandler: Skip initialization & flushing
    FixDataHandler->>Database: (Optional) Retrieve required data
    FixDataHandler-->>User: Return dry-run result
Loading
sequenceDiagram
    participant Caller
    participant Store
    participant DB

    Caller->>Store: Call fixDataStore
    Store->>DB: GetCFWithTS(key)
    DB-->>Store: Return (oldValue, oldTimestamp)
    Store->>Store: Compare value & timestamp against expected pair
    Note right of Store: Free oldValue and oldTimestamp memory
    Store-->>Caller: Return comparison result
Loading

Possibly related PRs

Suggested labels

backport/v1.4.x

Suggested reviewers

  • devashishdxt
  • yihuang
  • calvinaco

Poem

I'm a bouncy rabbit, quick on my feet,
Fixing bugs with a hop and a beat.
Timestamps aligned, and dry-runs complete,
Code flows smoother, oh what a treat!
🥕 Hoppin' along with changes so neat!
Cheers to our code, now ever so 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 b2742e2 and 5a9107f.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • versiondb/tsrocksdb/store.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • 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: build (macos-14)
  • GitHub Check: Run golangci-lint
  • GitHub Check: integration_tests (ibc_rly_gas)
  • GitHub Check: integration_tests (ibc_rly_evm)
  • GitHub Check: build (macos-latest)
  • GitHub Check: integration_tests (ibc)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: integration_tests (unmarked)
  • GitHub Check: Analyze (go)
🔇 Additional comments (2)
versiondb/tsrocksdb/store.go (1)

270-277: LGTM! Improved data verification in fixDataStore

The changes enhance the fix operation by:

  1. Using GetCFWithTS to efficiently retrieve both value and timestamp in a single call
  2. Properly comparing both value and timestamp to ensure complete data verification
  3. Maintaining good memory management with appropriate Free() calls
CHANGELOG.md (1)

10-14: LGTM! Changelog entries are accurate and well-placed

The new entries properly document:

  1. The bug fix for optimizing fixdata operation using GetCFWithTS
  2. The improvement for skipping batch operations during dry-run
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

codecov bot commented Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.56%. Comparing base (a3c2f70) to head (5a9107f).
Report is 38 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1748       +/-   ##
===========================================
+ Coverage   16.87%   35.56%   +18.68%     
===========================================
  Files          72      126       +54     
  Lines        6163    11920     +5757     
===========================================
+ Hits         1040     4239     +3199     
- Misses       5000     7256     +2256     
- Partials      123      425      +302     
Files with missing lines Coverage Δ
versiondb/tsrocksdb/store.go 57.58% <100.00%> (ø)

... and 70 files with indirect coverage changes

@mmsqe mmsqe marked this pull request as ready for review February 18, 2025 01:15
@mmsqe mmsqe requested a review from a team as a code owner February 18, 2025 01:15
@mmsqe mmsqe requested review from calvinaco and thomas-nguy and removed request for a team February 18, 2025 01:15
@mmsqe mmsqe added this pull request to the merge queue Feb 18, 2025
Merged via the queue into crypto-org-chain:main with commit a0d77b3 Feb 18, 2025
38 checks passed
mmsqe added a commit to mmsqe/cronos that referenced this pull request Feb 24, 2025
…rypto-org-chain#1748)

* Problem: need run fixdata multiple times when no timestamp checking

query with GetCFWithTS to compare both timestamp and key

* cleanup

* doc
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.

2 participants