yihuang commented 2 months ago

Solution:

change to jsonmerge package

👮🏻👮🏻👮🏻 !!!! 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 configuration management with nested dictionaries for improved clarity and organization.
- Introduced the jsonmerge library for more robust JSON merging capabilities.
Bug Fixes
- Simplified JSON configuration parsing logic, ensuring consistent handling of configuration patches.
Documentation
- Updated documentation to reflect changes in configuration patching and merging processes.
Chores
- Added jsonmerge as a new dependency to enhance JSON handling capabilities.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve restructuring configuration management within the testground/benchmark project. Key modifications include the introduction of nested dictionaries for configuration patches, the adoption of the jsonmerge library for merging JSON objects, and updates to functions handling TOML and JSON patching. Additionally, the pyproject.toml file now includes a dependency on jsonmerge, enhancing the project's capabilities in managing configuration data.

Changes

Files	Change Summary
`testground/benchmark/benchmark/peer.py`	Restructured configuration patching logic to use nested dictionaries and updated merging logic using `jsonmerge`.
`testground/benchmark/benchmark/stateless.py`	Removed JSON parsing logic from `_gen` function, simplifying code and assuming JSON-compatible input.
`testground/benchmark/benchmark/utils.py`	Removed `patch_dict` function; updated `patch_toml` and `patch_json` functions for improved merging of nested structures.
`testground/benchmark/pyproject.toml`	Added `jsonmerge` dependency with version constraint `^1.9.2`.

Possibly related PRs

1561: The changes in stateless.py regarding the handling of configuration patches are related to the restructuring of configuration management in the main PR, as both involve enhancing the flexibility and organization of configuration settings.
1574: The modifications to the gen function in stateless.py to accept a consolidated options dictionary align with the main PR's focus on improving configuration management and patching logic, indicating a shared goal of enhancing configurability within the Testground framework.

Suggested reviewers

yihuang
mmsqe
devashishdxt

Poem

🐰 In the land of code where patches grow,
Nested structures bloom, a lovely show.
With jsonmerge now in play,
Configuration dances, bright and gay.
A hop, a skip, to cleaner ways,
Our code now sings in joyful rays! 🌼

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 5541b41f802367f2350bca902eaff034d53e7dc6 and c6661a7340df45f6f050a8e67b9b97891a6e8348.

Files selected for processing (1)

* testground/benchmark/benchmark/peer.py (2 hunks)

Files skipped from review as they are similar to previous changes (1)

* testground/benchmark/benchmark/peer.py

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 15.24%. Comparing base (73c19da) to head (c6661a7). Report is 1 commits behind head on main.

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1591/graphs/tree.svg?width=650&height=150&src=pr&token=92w0Dz1Coj&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain)](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1591?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain) ```diff @@ Coverage Diff @@ ## main #1591 +/- ## ======================================= Coverage 15.24% 15.24% ======================================= Files 67 67 Lines 4874 4874 ======================================= Hits 743 743 Misses 4037 4037 Partials 94 94 ```

crypto-org-chain / cronos

Problem: config patch don't support list #1591

PR Checklist:

Summary by CodeRabbit

Walkthrough

Changes

Possibly related PRs

1561: The changes in `stateless.py` regarding the handling of configuration patches are related to the restructuring of configuration management in the main PR, as both involve enhancing the flexibility and organization of configuration settings.

1574: The modifications to the `gen` function in `stateless.py` to accept a consolidated `options` dictionary align with the main PR's focus on improving configuration management and patching logic, indicating a shared goal of enhancing configurability within the Testground framework.

Suggested reviewers

Poem

Codecov Report

crypto-org-chain / cronos

Problem: config patch don't support list #1591

PR Checklist:

Summary by CodeRabbit

Walkthrough

Changes

Possibly related PRs

1561: The changes in stateless.py regarding the handling of configuration patches are related to the restructuring of configuration management in the main PR, as both involve enhancing the flexibility and organization of configuration settings.

1574: The modifications to the gen function in stateless.py to accept a consolidated options dictionary align with the main PR's focus on improving configuration management and patching logic, indicating a shared goal of enhancing configurability within the Testground framework.

Suggested reviewers

Poem

Codecov Report

1561: The changes in `stateless.py` regarding the handling of configuration patches are related to the restructuring of configuration management in the main PR, as both involve enhancing the flexibility and organization of configuration settings.

1574: The modifications to the `gen` function in `stateless.py` to accept a consolidated `options` dictionary align with the main PR's focus on improving configuration management and patching logic, indicating a shared goal of enhancing configurability within the Testground framework.