Problem: testground block stats don't calculate tps directly

[yihuang]

Solution:

• add tps calculation, extract from Problem: test transactions can't be saved and reused #1575

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

• Have you read the CONTRIBUTING.md?
• Does your PR follow the C4 patch requirements?
• Have you rebased your work on top of the latest master?
• Have you checked your code compiles? (make)
• Have you included tests for any non-trivial functionality?
• Have you checked your code passes the unit tests? (make test)
• Have you checked your code formatting is correct? (go fmt)
• Have you checked your basic code style is fine? (golangci-lint run)
• If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
• If your changes affect the client infrastructure, have you run the integration test?
• If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
• If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
• If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

• New Features

  • Introduced a new module for calculating and analyzing transaction throughput (TPS) for blockchain blocks.
  • Added functionality to gather and output block statistics, including TPS metrics.
  • Enhanced blockchain interaction capabilities with new functions for retrieving block height and transaction data.

• Bug Fixes

  • Removed outdated functions that were no longer necessary for local RPC interactions, improving code clarity and maintainability.

[coderabbitai]

Warning

Rate limit exceeded

@yihuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 34 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 2a2c092 and 1ae4501.

Walkthrough

The pull request introduces significant changes to the stateless.py, stats.py, and utils.py files within the testground/benchmark/benchmark module. It removes several functions related to local RPC interactions in stateless.py, while stats.py is added to provide transaction throughput calculations. New functions for fetching block data are introduced in utils.py, enhancing the module's capabilities for blockchain interactions.

Changes

Files	Change Summary
testground/benchmark/benchmark/stateless.py	Removed functions for local RPC interactions: block_height, block, block_txs, and dump_block_stats.
testground/benchmark/benchmark/stats.py	Added functionality to calculate transaction throughput (TPS) and gather block statistics with new functions: calculate_tps, dump_block_stats.
testground/benchmark/benchmark/utils.py	Introduced functions to interact with local RPC: block_height, block, block_txs, and defined a constant for the local RPC endpoint.

Possibly related PRs

• Problem: configs are baked in testground #1561: Modifications to the stateless.py file, indicating a direct connection to the main PR.
• Problem: testground validator load generator not configurable #1576: Enhancements to configuration options related to load generation in the stateless.py file, aligning with the overall theme of functionality modifications.

Suggested reviewers

• @yihuang
• @calvinaco
• @mmsqe

Poem

In the code where rabbits hop,
Functions changed, we won't stop.
Stats now dance, TPS in sight,
Fetching blocks, oh what a delight!
With every line, our code grows bright,
Hopping forward, coding's pure light! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table.
  -- @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.

[coderabbitai]

Actionable comments posted: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 458aff0 and bcb5cbf.

Files selected for processing (3)

• testground/benchmark/benchmark/stateless.py (1 hunks)
• testground/benchmark/benchmark/stats.py (1 hunks)
• testground/benchmark/benchmark/utils.py (2 hunks)

Additional comments not posted (5)

testground/benchmark/benchmark/stats.py (3)

10-11: LGTM!

The check for at least 2 blocks is a good edge case handling.

---

19-22: LGTM!

The function docstring provides a clear description of the function's purpose.

---

34-35: LGTM!

Sorting the TPS values in descending order and printing the top 5 values is a good way to highlight the peak performance.

testground/benchmark/benchmark/stateless.py (2)

26-26: LGTM!

Moving the dump_block_stats function to a separate stats module improves code organization and modularity.

---

29-29: Verify the impact of removing the imported functions.

The removal of the block_height, block_txs, and wait_for_w3 functions suggests a shift away from directly querying the local RPC for block data within this module. Please ensure that this change does not break any other parts of the codebase that may rely on these functions.

Run the following script to search for usages of these functions in the codebase:

If any usages are found outside the testground/benchmark/benchmark directory, please update them accordingly to avoid breaking the code.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.24%. Comparing base (dad299e) to head (1ae4501).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1586   +/-   ##
=======================================
  Coverage   15.24%   15.24%           
=======================================
  Files          67       67           
  Lines        4874     4874           
=======================================
  Hits          743      743           
  Misses       4037     4037           
  Partials       94       94