fix: add failure retries in testWitness

[colinlyguo]

1. Purpose or design rationale of this PR

This PR adds retries in testWitness, which sometimes calculates an incorrect state root. The issue is probably located in blockchain.Processor().Process.

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:

• fix: A bug fix

3. Deployment tag versioning

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

• Yes

4. Breaking change label

Does this PR have the breaking-change label?

• This PR is not a breaking change

Summary by CodeRabbit

Summary by CodeRabbit

• Bug Fixes

  • Enhanced error messaging to provide improved context during failure conditions, aiding in troubleshooting.

• Chores

  • Updated the patch version from 31 to 32 to signal the latest release update.

[coderabbitai]

Walkthrough

This pull request enhances error handling in the generateWitness and testWitness functions by introducing retry logic and detailed error messages that include hexadecimal representations of state roots and block hashes. Additionally, the patch version is incremented in params/version.go by updating the VersionPatch constant from 31 to 32, reflecting the new patch level.

Changes

File(s)	Change Summary
eth/api.go	Modified generateWitness to include a retry loop for testWitness and enhanced error handling with detailed messages. Updated testWitness to check errors from rawdb.ReadDiskStateRoot.
params/version.go	Incremented VersionPatch constant from 31 to 32.

Possibly related PRs

• fix: avoid using snapshots when generating witness #1116: The changes in the main PR are related to the modifications in the generateWitness function, as both PRs enhance error handling and involve the witness generation process in eth/api.go.

Suggested labels

bump-version

Suggested reviewers

• georgehao
• Thegaram

Poem

I'm a hopping rabbit in a code-filled glen,
Checking errors at every turn again.
Hex messages now light my midnight path,
With version bumps steering clear of wrath.
Bugs scatter as I nibble code with delight—hip hip hooray! 🐇🥕

---

📜 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 1675790 and 838c8f1.

📒 Files selected for processing (1)

• eth/api.go (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

eth/api.go (4)

core/blockchain.go (1)

• BlockChain (178-231)

core/stateless/witness.go (1)

• Witness (38-47)

core/rawdb/accessors_state.go (1)

• ReadDiskStateRoot (104-110)

core/state/statedb.go (1)

• New (133-161)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: test
• GitHub Check: Analyze (go)

🔇 Additional comments (6)

eth/api.go (6)

371-382: Good addition of retry logic to handle intermittent failures.

The implementation of retry logic for the testWitness function is a good solution for handling occasional state root calculation failures. The code now attempts up to 5 retries before returning the witness along with the last error encountered, which should significantly reduce transient failures.

I appreciate that the code includes proper warning logs that will help with monitoring and debugging when failures occur.

---

386-392: Improved error handling for state root reading.

The enhanced error handling for ReadDiskStateRoot is a good improvement. By including the hex representation of the state root in the error message, it will be much easier to debug state root issues.

The addition of debug logging when a disk root is used is also helpful for tracing the execution flow.

---

398-398: Better error reporting for state database creation.

Including the state root hex representation in the error message for state database creation failures is a good enhancement to help with debugging.

---

403-407: Enhanced error messages for block processing failures.

The improved error messages now include block number and hash in hex format, which provides much more context for debugging. This will make it easier to identify specific blocks that are causing processing issues.

---

411-417: Added error handling and debug logging for post state root.

Similar to the improvements made for the initial state root check, this change adds proper error handling for reading the post state root and includes helpful debug logging. The consistent approach to error handling throughout the function is good practice.

---

419-428: Enhanced state root mismatch error reporting with witness data.

This is a significant improvement to the error reporting. When a state root mismatch occurs:

1. A debug log is now generated with the expected and actual root values
2. The execution witness is included in the error message as JSON
3. The error message includes detailed information about the block number, hash, and state roots

Including the full witness in the error message will be extremely valuable for debugging state root mismatches, as it contains the complete context needed to reproduce and analyze the issue.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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