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

Check for int64 overflow when computing uint64 diff #2181

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fridrik01
Copy link
Contributor

In #2171 we added the beacon_kit.state.payload_consensus_timestamp_diff metric for tracking the diff between the payload and consensus timestamps.

In that PR we ignored int64 overflow which this PR addresses. Here we explicitly check ahead of time if an overflow will happen and log an error if that is the case.

@fridrik01 fridrik01 self-assigned this Nov 27, 2024
Copy link
Contributor

coderabbitai bot commented Nov 27, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

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 Nov 27, 2024

Codecov Report

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

Project coverage is 26.65%. Comparing base (8ff5bd3) to head (e83e8d8).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
...ate-transition/pkg/core/state_processor_payload.go 50.00% 2 Missing and 2 partials ⚠️
mod/state-transition/pkg/core/metrics.go 70.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2181      +/-   ##
==========================================
+ Coverage   26.56%   26.65%   +0.08%     
==========================================
  Files         363      363              
  Lines       16493    16520      +27     
  Branches       12       12              
==========================================
+ Hits         4382     4403      +21     
- Misses      11829    11833       +4     
- Partials      282      284       +2     
Files with missing lines Coverage Δ
mod/primitives/pkg/math/u64.go 100.00% <100.00%> (ø)
mod/state-transition/pkg/core/metrics.go 82.35% <70.00%> (-17.65%) ⬇️
...ate-transition/pkg/core/state_processor_payload.go 22.48% <50.00%> (+0.08%) ⬆️

// add telemetry for the diff between payloadTimestamp and
// consensusTimestamp
err := sp.metrics.gaugePayloadConsensusTimestampDiff(
payloadTimestamp, consensusTimestamp)
Copy link
Collaborator

Choose a reason for hiding this comment

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

How about instead of all of this we go though time.Duration?
Turn the timestamp into a time.Time objects and get diff as TimeA.Sub(TimeB)?

Copy link
Contributor Author

@fridrik01 fridrik01 Nov 27, 2024

Choose a reason for hiding this comment

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

That I think would still result in us needing to deal with uint64 to int64 casting which would trigger gosec, so not any better than what's on main branch already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants