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: time difference calculations for new_tps #2655

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

edisontim
Copy link
Contributor

@edisontim edisontim commented Nov 7, 2024

Description

Fixes panic attempt to subtract with overflow

Related issue

Closes #2654

Summary by CodeRabbit

  • New Features

    • Enhanced transaction per second (TPS) calculation for improved accuracy by using the current system time.
  • Bug Fixes

    • Addressed timing discrepancies in TPS calculations to reflect actual current time.

Copy link

coderabbitai bot commented Nov 7, 2024

Walkthrough

Ohayo! This pull request introduces a modification in the Executor struct's handle_query_type method, specifically for handling the UpdateCursors query type. It replaces the previous time retrieval method using Instant::now() with SystemTime::now() to calculate transactions per second (TPS). This change ensures that TPS calculations reflect the actual current time rather than the elapsed time since the last recorded instant. The overall structure and control flow remain unchanged.

Changes

File Path Change Summary
crates/torii/core/src/executor.rs Added import for SystemTime and UNIX_EPOCH; modified TPS calculation to use SystemTime instead of Instant.

Assessment against linked issues

Objective Addressed Explanation
Panic when updating cursor (2654)

Possibly related PRs

Suggested reviewers

  • glihm

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 resolve resolve all the CodeRabbit review comments.
  • @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.

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c364d13 and 016437c.

📒 Files selected for processing (1)
  • crates/torii/core/src/executor.rs (2 hunks)
🔇 Additional comments (1)
crates/torii/core/src/executor.rs (1)

4-4: LGTM! Necessary imports added.

The addition of SystemTime and UNIX_EPOCH imports is appropriate for the time-based calculations.

Comment on lines +337 to +340
let current_time =
SystemTime::now().duration_since(UNIX_EPOCH).unwrap().as_secs();

num_transactions / (current_time - cursor_timestamp)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Ohayo sensei! The time calculation needs safer handling.

While the change addresses the overflow panic, there are several concerns with the current implementation:

  1. Using unwrap() on duration_since could panic if the system clock is set before UNIX_EPOCH
  2. The time difference could still be zero if system time equals cursor_timestamp
  3. The calculation might be incorrect if system time is less than cursor_timestamp

Here's a safer implementation:

-                            let current_time =
-                                SystemTime::now().duration_since(UNIX_EPOCH).unwrap().as_secs();
-
-                            num_transactions / (current_time - cursor_timestamp)
+                            let current_time = SystemTime::now()
+                                .duration_since(UNIX_EPOCH)
+                                .unwrap_or_default()
+                                .as_secs();
+                            
+                            if current_time <= cursor_timestamp {
+                                // Fallback to 1 second if timestamps are invalid
+                                num_transactions
+                            } else {
+                                num_transactions / (current_time - cursor_timestamp)
+                            }

This implementation:

  1. Uses unwrap_or_default() to handle duration_since errors
  2. Handles the case where system time ≤ cursor_timestamp
  3. Provides a reasonable fallback for TPS calculation
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
let current_time =
SystemTime::now().duration_since(UNIX_EPOCH).unwrap().as_secs();
num_transactions / (current_time - cursor_timestamp)
let current_time = SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap_or_default()
.as_secs();
if current_time <= cursor_timestamp {
// Fallback to 1 second if timestamps are invalid
num_transactions
} else {
num_transactions / (current_time - cursor_timestamp)
}

Copy link

codecov bot commented Nov 7, 2024

Codecov Report

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

Project coverage is 57.43%. Comparing base (c364d13) to head (016437c).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
crates/torii/core/src/executor.rs 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2655      +/-   ##
==========================================
- Coverage   57.46%   57.43%   -0.03%     
==========================================
  Files         400      400              
  Lines       49963    49965       +2     
==========================================
- Hits        28709    28698      -11     
- Misses      21254    21267      +13     

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

@kariy kariy requested review from glihm and Larkooo November 7, 2024 17:43
@kariy kariy merged commit 2050ec4 into dojoengine:main Nov 7, 2024
12 of 14 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.

[torii] Panic when updating cursor
3 participants