Skip to content

fix: ignore key-not-found errors in testWitness #1164

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

Merged
merged 2 commits into from
Apr 2, 2025

Conversation

omerfirmak
Copy link

@omerfirmak omerfirmak commented Apr 2, 2025

1. Purpose or design rationale of this PR

...

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling to prevent unnecessary interruptions when expected data is missing, ensuring a smoother and more resilient experience.
  • Chores

    • Updated the patch version to reflect the latest maintenance improvements.

Copy link

coderabbitai bot commented Apr 2, 2025

Walkthrough

The changes modify error handling in the testWitness function in eth/api.go by allowing the process to continue when a state root is not found (i.e., when the error is leveldb.ErrNotFound). A new import for the leveldb package was added to support this check. Additionally, the patch version in params/version.go is updated from 34 to 35.

Changes

File(s) Change Summary
eth/api.go Modified error handling in testWitness to ignore errors of type leveldb.ErrNotFound for both state root and post-state root checks; added new leveldb import.
params/version.go Updated constant VersionPatch from 34 to 35.

Sequence Diagram(s)

sequenceDiagram
    participant T as testWitness
    participant R as rawdb.ReadDiskStateRoot

    T->>R: Request state root
    alt Error occurs
        R-->>T: Return error
        alt Error is leveldb.ErrNotFound
            T->>T: Ignore error, continue processing
        else Other error
            T->>T: Return error and halt processing
        end
    else Successful read
        R-->>T: Return state root
    end
Loading

Possibly related PRs

Suggested reviewers

  • georgehao
  • jonastheis
  • colinlyguo

Poem

I'm a coding rabbit, quick on my feet,
Skipping over errors that I meet.
With leveldb in tow, I hop with delight,
No missing roots to give me a fright.
Version patched and clean, I cheer in glee—
Hopping through code, wild and free! 🐇

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

colinlyguo
colinlyguo previously approved these changes Apr 2, 2025
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: 0

🧹 Nitpick comments (1)
eth/api.go (1)

373-374: Consider updating the FIXME comment

There's a FIXME comment above the testWitness usage that mentions occasional state root mismatches. Since you're modifying the error handling in testWitness, consider updating this comment to reflect that key-not-found errors are now being handled.

-// FIXME: testWitness will fail from time to time, the problem is caused by occasional state root mismatch
-// after processing the block based on witness. We need to investigate the root cause and fix it.
+// FIXME: testWitness will fail from time to time, the problem is caused by occasional state root mismatch
+// after processing the block based on witness. Key-not-found errors are now ignored, but we still need
+// to investigate the root cause of other mismatches and fix them.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bbe9809 and c4a7322.

📒 Files selected for processing (2)
  • eth/api.go (3 hunks)
  • params/version.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-and-push
  • GitHub Check: Analyze (go)
🔇 Additional comments (4)
params/version.go (1)

27-27: Appropriate version bump for bug fix

The patch version increment from 34 to 35 is consistent with semantic versioning for a bug fix change that doesn't alter the API.

eth/api.go (3)

47-47: Properly added required import for error handling

The leveldb package import is correctly added to support the new error checking functionality.


388-389: Appropriate handling of key-not-found errors

The modification to error handling now correctly allows execution to continue when a state root key is not found in the database (leveldb.ErrNotFound), while still properly handling other error types. This addresses the issue mentioned in the PR title.


413-414: Consistent error handling for post-state root

The same error handling pattern is appropriately applied to the post-state root check, ensuring consistent behavior throughout the function. This correctly implements the PR's goal of ignoring key-not-found errors in testWitness.

@yiweichi yiweichi self-requested a review April 2, 2025 20:30
@icemelon icemelon merged commit d6b4c96 into develop Apr 2, 2025
5 checks passed
@icemelon icemelon deleted the omerfirmak/fix-test-witness branch April 2, 2025 22:18
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.

4 participants