feat(torii): make poll time configurable #2327
Conversation
WalkthroughThe recent updates enhance the configuration capabilities of the application by modifying command-line argument handling and internal settings. Key changes include adjusting the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Application
participant Config
User->>Application: Start application with parameters
Application->>Config: Initialize with Args
Config-->>Application: Return updated settings
Application->>Config: Polling operation initiated
Config-->>Application: Use polling_interval
Application->>User: Application is running with new settings
Poem
TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.github.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- bin/torii/src/main.rs (3 hunks)
- crates/torii/core/src/engine.rs (3 hunks)
Additional comments not posted (8)
bin/torii/src/main.rs (4)
111-111: Change toevents_chunk_sizedefault value is appropriate.The default value for
events_chunk_sizehas been updated to1024, which is a power of two and may improve performance.
115-115: Change toindex_pendingbehavior is sensible.The
index_pendingfield now explicitly sets its value, which helps avoid ambiguity in command-line arguments.
118-120: Addition ofpolling_intervalenhances configurability.The new
polling_intervalfield allows users to specify the polling interval in milliseconds, providing more control over the application's behavior.
192-192: Usage ofpolling_intervalinEngineConfigis correct.The
polling_intervalis correctly utilized in theEngineConfiginitialization, ensuring the new configuration option is applied.crates/torii/core/src/engine.rs (4)
37-37: Renamingblock_timetopolling_intervalimproves clarity.The field's purpose is clearer, and the default value of 500 milliseconds aligns with the changes in
main.rs.
46-46: Default value forpolling_intervalis reasonable.Setting the default to 500 milliseconds balances responsiveness with resource usage.
48-48: Change toevents_chunk_sizedefault value is appropriate.Increasing the default to 1024, a power of two, may improve performance.
49-49: Settingindex_pendingdefault totrueis sensible.Indexing pending blocks by default is likely desirable in most scenarios.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2327 +/- ##
==========================================
- Coverage 68.50% 67.30% -1.21%
==========================================
Files 331 354 +23
Lines 41337 46512 +5175
==========================================
+ Hits 28319 31306 +2987
- Misses 13018 15206 +2188 ☔ View full report in Codecov by Sentry. |
Summary by CodeRabbit
New Features
polling_intervalparameter for enhanced control over polling frequency, defaulting to 500 milliseconds.events_chunk_sizedefault to 1024 for better event chunk management.index_pendingto ensure explicit setting and defaulting to true.Bug Fixes
block_timetopolling_intervalfor clarity, improving configuration understanding.These changes enhance the application's configurability and performance, offering users more options for parameter settings.