feat(torii-core): log when engine syncing has been reestablished

[Larkooo]

Summary by CodeRabbit

• New Features
  • Enhanced transaction processing that now logs "world transactions" more clearly.
  • Introduced a new type alias to indicate the presence of world events in transaction processing.
• Improvements
  • Improved error handling and logging during synchronization, enabling better backoff management.
  • Optimized block processing logic to prevent redundant operations.
  • Updated method feedback to provide clearer indications of world event occurrences during transactions.

[coderabbitai]

Walkthrough

Ohayo, sensei! The recent updates to the Engine struct in the engine.rs file significantly improve its functionality by enhancing error handling, logging, and transaction processing. A new type alias clarifies the detection of world events, while synchronization logic now more effectively manages errors. The process_transaction method also returns a result indicating whether a world event occurred, greatly improving feedback clarity. Overall, these enhancements bolster the robustness and clarity of the code.

Changes

Files	Change Summary
crates/torii/core/src/engine.rs	Introduced HasWorldEvent type alias; modified sync_to_head with erroring_out for improved error management; updated transaction processing to log world transactions; optimized block processing logic; altered process_transaction to return Result<HasWorldEvent>.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Engine
    participant Provider

    User->>Engine: process_transaction(transaction_hash, block_number, block_timestamp)
    Engine->>Provider: Validate transaction
    alt Transaction valid
        Engine->>Engine: Log transaction hash if world transaction
        Engine->>User: Return Result<HasWorldEvent>
    else Transaction error
        Engine->>Engine: Set erroring_out=true
        Engine->>User: Log error
        Engine->>Provider: Backoff and retry
    end

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eae398b and 50726a1.

Files selected for processing (1)

• crates/torii/core/src/engine.rs (2 hunks)

Additional comments not posted (4)

crates/torii/core/src/engine.rs (4)

Line range hint 97-110:
Ohayo, sensei! Enhanced error handling looks great.

The introduction of erroring_out and the logging when syncing is reestablished are excellent for improving observability and error management.

---

Line range hint 130-144:
Ohayo, sensei! Sync logic improvements are solid.

The refinements in error handling and logging within sync_to_head enhance the robustness of the synchronization process.

---

Line range hint 267-290:
Ohayo, sensei! Return type update enhances clarity.

Changing the return type of process_transaction_and_receipt to Result<HasWorldEvent> provides clearer feedback regarding world events.

---

116-116: Verify the backoff logic.

Ensure that the backoff logic correctly handles the exponential delay and resets appropriately when syncing is reestablished.

Verification successful

---

Ohayo, sensei! The backoff logic is working correctly. The code implements exponential backoff with a reset mechanism when syncing is reestablished. The erroring_out variable effectively manages error states, ensuring the delay doubles on errors and resets upon successful syncing.

• The backoff delay starts at 1 second and doubles with each error, capping at 60 seconds.
• When syncing resumes, the delay resets to 1 second, and erroring_out is set to false.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the backoff logic in the `start` function.

# Test: Search for the usage of `backoff_delay` and `erroring_out`. Expect: Correct reset and exponential backoff logic.
rg --type rust -A 5 $'backoff_delay'

Length of output: 1629

---

Script:

#!/bin/bash
# Description: Search for the usage of `erroring_out` to verify its role in the backoff logic.
rg --type rust -A 5 $'erroring_out'

Length of output: 1565

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 69.59%. Comparing base (00770bd) to head (50726a1).
Report is 3 commits behind head on main.

Files	Patch %	Lines
crates/torii/core/src/engine.rs	0.00%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2301      +/-   ##
==========================================
- Coverage   69.60%   69.59%   -0.01%     
==========================================
  Files         352      352              
  Lines       46031    46037       +6     
==========================================
  Hits        32040    32040              
- Misses      13991    13997       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.