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

opt(torii): global "sync" for pending & range syncing #2320

Closed
wants to merge 5 commits into from

Conversation

Larkooo
Copy link
Collaborator

@Larkooo Larkooo commented Aug 20, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a streamlined synchronization method for blockchain transactions, replacing previous segmented processes with a unified approach.
    • Enhanced efficiency in transaction handling through improved logic that directly manages pending transactions within the synchronization process.
  • Bug Fixes

    • Adjusted method calls in tests to reflect the new synchronization behavior, ensuring that state management functions correctly with the updated logic.

Copy link

coderabbitai bot commented Aug 20, 2024

Walkthrough

Ohayo, sensei! The recent changes enhance the synchronization logic within the Engine implementation. The sync_to_head method has been renamed to sync, consolidating the handling of blockchain transactions into a single, streamlined method. This new approach simplifies control flow and improves efficiency by directly integrating pending transactions into block processing. Overall, these modifications boost clarity and performance in the engine's synchronization process.

Changes

Files Change Summary
crates/torii/core/src/engine.rs Renamed sync_to_head to sync, consolidating block and pending transaction processing into a single method.
crates/torii/core/src/sql_test.rs Updated to call the new sync method instead of sync_to_head, maintaining parameter consistency.
crates/torii/graphql/src/tests/mod.rs Modified test to use sync instead of sync_to_head, indicating a shift in synchronization behavior.
crates/torii/grpc/src/server/tests/entities_test.rs Changed test to call sync instead of sync_to_head, altering the synchronization logic while preserving structure.

Sequence Diagram(s)

sequenceDiagram
    participant Engine
    participant BlockProcessor
    participant TransactionManager

    Engine->>BlockProcessor: sync(from, pending_block_tx)
    BlockProcessor->>TransactionManager: process pending transactions
    BlockProcessor->>BlockProcessor: process blocks
    TransactionManager->>Engine: return updated state
Loading

This diagram illustrates the new flow of the synchronization process in the Engine, highlighting the interaction between the engine, block processor, and transaction manager.


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 46b2ac1 and 1edd4bf.

Files selected for processing (1)
  • crates/torii/core/src/engine.rs (8 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.

@glihm glihm changed the title opt(torii): global "sync" for pending & range syncijng opt(torii): global "sync" for pending & range syncing Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

Attention: Patch coverage is 80.95238% with 4 lines in your changes missing coverage. Please review.

Project coverage is 67.42%. Comparing base (bb7d7df) to head (1edd4bf).
Report is 19 commits behind head on main.

Files Patch % Lines
crates/torii/core/src/engine.rs 80.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2320      +/-   ##
==========================================
+ Coverage   67.31%   67.42%   +0.10%     
==========================================
  Files         354      354              
  Lines       46433    46443      +10     
==========================================
+ Hits        31258    31314      +56     
+ Misses      15175    15129      -46     

☔ 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
@lambda-0x
Copy link
Contributor

implemented similar optimizations along with erc changes in #2330

@Larkooo Larkooo closed this Aug 27, 2024
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