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

fix: importer to wait db close #1050

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

beer-1
Copy link
Contributor

@beer-1 beer-1 commented Feb 23, 2025

Here is context: cosmos/cosmos-sdk#23740

When we use statesync, it is using this IAVL importer but sometimes the IAVL store is empty even there is no notable errors. And after digging the issue, I found importer is not waiting the batch.Close().

This PR is to fix to importer to wait previous batch's WriteSync() and Close().

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced error detection during processing to capture issues immediately, which helps prevent unexpected disruptions.
  • Refactor

    • Streamlined control flow in critical data operations, ensuring improved synchronization and overall system reliability.

@beer-1 beer-1 requested a review from a team as a code owner February 23, 2025 13:53
Copy link

coderabbitai bot commented Feb 23, 2025

Walkthrough

This change refines error handling and control flow within the writeNode and Commit methods of the Importer struct in import.go. The modifications remove a redundant error declaration in favor of a short variable declaration and introduce an immediate error check. Additionally, the batch writing process now leverages WriteSync() instead of Write(), ensuring errors from batch operations are handled appropriately during commit processing.

Changes

File Change Summary
import.go Updated error handling in the writeNode method by using a short variable declaration and immediate error checks after retrieving from the inflight commit. Changed batch operation from Write() to WriteSync() and restructured error checking in the Commit method for consistency.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Importer as writeNode()
    participant Inflight as InflightCommit
    participant Batch

    Caller->>Importer: call writeNode()
    Importer->>Inflight: check inflight commit error
    alt Error exists
        Inflight-->>Importer: return error
        Importer-->>Caller: return error
    else No error
        Inflight-->>Importer: return nil
        Importer->>Batch: call WriteSync()
        Batch-->>Importer: return batch result/error
        alt Batch error
            Importer-->>Caller: return error
        else Successful write
            Importer-->>Caller: proceed with success
        end
    end
Loading
sequenceDiagram
    participant Caller
    participant Importer as Commit()
    participant Inflight as InflightCommit
    participant Batch

    Caller->>Importer: call Commit()
    Importer->>Inflight: await inflight commit
    alt Inflight error exists
        Inflight-->>Importer: return error
        Importer-->>Caller: return error
    else No error
        Inflight-->>Importer: return nil
        Importer->>Batch: call WriteSync() for batch write
        Batch-->>Importer: return batch response/error
        alt Batch error
            Importer-->>Caller: return error
        else Successful commit
            Importer-->>Caller: commit successful
        end
    end
Loading

Suggested reviewers

  • kocubinski
  • julienrbrt

Poem

I hopped through code with nimble feet,
Tweaking errors where they’d sneak.
Syncing batches in a perfect rhyme,
Ensuring commits stay in line.
With a cheerful hop and a gentle cheer,
I, the rabbit, celebrate code so dear!
🐇✨

✨ 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

@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 details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0bce70d and 68bfc85.

📒 Files selected for processing (1)
  • import.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (go)
  • GitHub Check: Test
  • GitHub Check: Benchmarks
🔇 Additional comments (1)
import.go (1)

85-103: LGTM! Improved error handling and synchronous batch operations.

The changes enhance reliability by:

  1. Immediately checking and propagating errors from previous batch operations
  2. Using WriteSync() to ensure synchronous completion
  3. Properly handling errors from both WriteSync() and Close() operations

This aligns well with the PR objective of ensuring proper wait for batch operations.

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