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(torii-core): engine update cursor when world event #2300

Merged
merged 2 commits into from
Aug 15, 2024

Conversation

Larkooo
Copy link
Collaborator

@Larkooo Larkooo commented Aug 15, 2024

When we're in sync pending and update our pending txn cursor, we first check if that processed txn had a world event in it so that the sync range that uses the get_events API with the world address can catch it

Summary by CodeRabbit

  • New Features

    • Enhanced transaction processing with improved logging and control flow.
    • Introduced a new result type to indicate the outcome of transaction processing.
  • Bug Fixes

    • Improved handling of pending transactions to ensure proper logging and state tracking.
  • Refactor

    • Adjusted block processing logic to prevent duplicate processing and ensure sequential handling.

Copy link

coderabbitai bot commented Aug 15, 2024

Walkthrough

Ohayo, sensei! The recent updates to the Engine implementation significantly enhance the transaction and block processing logic. A new type alias, HasWorldEvent, is introduced, improving the return type of the process_transaction method. The handling of pending transactions has been refined with additional logging, and block processing is now managed sequentially based on block numbers. Overall, these changes emphasize clearer control flow and enhanced logging for better tracking of transaction states.

Changes

Files Change Summary
crates/torii/core/src/engine.rs Introduced HasWorldEvent type alias as bool; modified process_transaction to return Result<bool>. Enhanced logging for pending transactions and adjusted block processing logic for sequential handling based on block_number. Added logging after block processing.

Sequence Diagram(s)

sequenceDiagram
    participant Engine
    participant TransactionHandler
    participant Logger

    Engine->>TransactionHandler: process_transaction(transaction_hash, block_number, block_timestamp)
    TransactionHandler->>Logger: Log pending transaction
    Logger->>TransactionHandler: Confirm log
    TransactionHandler->>Engine: Return Result<HasWorldEvent>
Loading
sequenceDiagram
    participant Engine
    participant BlockProcessor
    participant Logger

    Engine->>BlockProcessor: process_block(block_number)
    BlockProcessor->>Logger: Log block processing
    Logger->>BlockProcessor: Confirm log
    BlockProcessor->>Engine: Return block processing result
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between de29780 and 69ca70b.

Files selected for processing (1)
  • crates/torii/core/src/engine.rs (7 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/torii/core/src/engine.rs

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.

Copy link

codecov bot commented Aug 15, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 69.55%. Comparing base (00770bd) to head (69ca70b).
Report is 5 commits behind head on main.

Files Patch % Lines
crates/torii/core/src/engine.rs 87.50% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2300      +/-   ##
==========================================
- Coverage   69.60%   69.55%   -0.05%     
==========================================
  Files         352      352              
  Lines       46031    46004      -27     
==========================================
- Hits        32040    32000      -40     
- Misses      13991    14004      +13     

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

crates/torii/core/src/engine.rs Outdated Show resolved Hide resolved
crates/torii/core/src/engine.rs Outdated Show resolved Hide resolved
@glihm
Copy link
Collaborator

glihm commented Aug 15, 2024

Thanks for addressing the comments @Larkooo. 👍

@glihm glihm merged commit 84f88fc into dojoengine:main Aug 15, 2024
13 checks passed
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