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

Problem: testground can't patch genesis #1574

Merged
merged 5 commits into from
Sep 13, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Sep 12, 2024

👮🏻👮🏻👮🏻 !!!! 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

    • Enhanced configurability of the genesis file generation process with the introduction of a genesis_patch parameter.
    • Consolidated configuration modifications into a single options parameter for streamlined handling.
    • Updated command-line options for generating test cases to use a single --options flag that accepts a JSON object, improving usability.
  • Bug Fixes

    • Adjusted function calls to accommodate new parameters, ensuring proper functionality.

@yihuang yihuang requested a review from a team as a code owner September 12, 2024 11:23
@yihuang yihuang requested review from mmsqe and devashishdxt and removed request for a team September 12, 2024 11:23
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

The changes involve modifications to the gen_genesis function in peer.py and the gen function in stateless.py. Both functions have been updated to include a new parameter, genesis_patch, which allows for additional configuration options during genesis file generation. Additionally, the gen function has consolidated previous parameters into a single options dictionary, enhancing the organization of configuration modifications. The maximum gas limit for blocks has also been increased from "81500000" to "163000000". The command-line options in the README.md have been restructured to use a single --options flag that accepts a JSON object.

Changes

File Path Change Summary
testground/benchmark/benchmark/peer.py Updated gen_genesis function to include genesis_patch parameter; modified invocation in bootstrap. Increased "consensus.params.block.max_gas" from "81500000" to "163000000".
testground/benchmark/benchmark/stateless.py Changed gen function to accept a single options parameter, consolidating config_patch and app_patch. Added extraction of genesis_patch from the options dictionary.
testground/README.md Restructured command-line options for generating test cases to use a single --options flag accepting a JSON object with multiple configuration parameters.

Possibly related PRs

  • Problem: configs are baked in testground #1561: This PR involves modifications to the stateless.py file, particularly the gen function, which now accepts config_patch and app_patch parameters. This is directly related to the main PR's updates to the gen_genesis function and its invocation, as both PRs enhance configurability through the introduction of new parameters for dynamic configuration management.

Poem

In the land of code, a patch was made,
A rabbit's hop, new paths displayed.
With gas limits raised, the blocks now soar,
Genesis sprinkles, we’ll code and explore!
Hopping through changes, with joy we cheer,
For every new feature, we hold so dear! 🐇✨

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 29e177f and 818356a.

Files selected for processing (1)
  • testground/benchmark/benchmark/stateless.py (2 hunks)
Additional context used
Ruff
testground/benchmark/benchmark/stateless.py

46-46: Do not use mutable data structures for argument defaults

Replace with None; initialize within function

(B006)

Additional comments not posted (3)
testground/benchmark/benchmark/stateless.py (3)

48-55: LGTM!

The consolidation of function parameters into the options dictionary and the extraction of configuration values with default values is a good change. The new genesis_patch configuration is also correctly extracted.


73-73: LGTM!

Passing the genesis_patch configuration to the gen_genesis function is the correct way to apply specific modifications to the genesis file.


51-54: LGTM!

The extraction of num_accounts, num_txs, config_patch, and app_patch configurations from the options dictionary with default values is correctly implemented.


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>.
    • 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 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
Contributor

@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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5c507d5 and 46ea9c8.

Files selected for processing (2)
  • testground/benchmark/benchmark/peer.py (3 hunks)
  • testground/benchmark/benchmark/stateless.py (2 hunks)
Additional context used
Ruff
testground/benchmark/benchmark/stateless.py

52-52: Do not use mutable data structures for argument defaults

Replace with None; initialize within function

(B006)

Additional comments not posted (3)
testground/benchmark/benchmark/peer.py (2)

42-42: LGTM!

The changes to the gen_genesis function call are consistent with the updated function signature. Passing an empty dictionary as the genesis_patch argument allows for potential future enhancements where specific patches can be applied dynamically to the genesis configuration.


97-99: Verify the impact of increasing the "consensus.params.block.max_gas" value.

The addition of the genesis_patch parameter enhances the flexibility of the genesis file generation process by allowing additional configuration options to be passed. This change looks good.

However, the significant increase in the value of "consensus.params.block.max_gas" from "81500000" to "163000000" suggests a substantial change in the gas limit for blocks. This change should be carefully reviewed and tested to ensure it aligns with the intended behavior and doesn't introduce any unintended consequences.

Please provide more context on the reasoning behind increasing the "consensus.params.block.max_gas" value and confirm that thorough testing has been performed to validate the impact of this change on the network's performance and transaction processing capabilities.

Also applies to: 114-114, 117-117

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

71-71: LGTM!

The usage of genesis_patch in the gen_genesis function call is correct. It passes the user-provided genesis patch to the gen_genesis function, allowing for additional modifications to the genesis configuration during its generation process.

testground/benchmark/benchmark/stateless.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.24%. Comparing base (5c507d5) to head (818356a).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

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

Copy link
Contributor

@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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 46ea9c8 and 7af9101.

Files selected for processing (1)
  • testground/benchmark/benchmark/stateless.py (2 hunks)
Additional context used
Ruff
testground/benchmark/benchmark/stateless.py

50-50: Do not use mutable data structures for argument defaults

Replace with None; initialize within function

(B006)

Additional comments not posted (1)
testground/benchmark/benchmark/stateless.py (1)

72-72: LGTM!

The addition of the genesis_patch parameter enhances the flexibility of the gen function by allowing users to apply specific patches to the genesis file. Passing it to the gen_genesis function is the correct way to utilize this new parameter.

testground/benchmark/benchmark/stateless.py Outdated Show resolved Hide resolved
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