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: don't support skipping check-tx in benchmark #1659

Merged
merged 4 commits into from
Oct 23, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Oct 23, 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

    • Added support for skipping check-tx in benchmarks.
    • Introduced a simplified transaction check mode for enhanced transaction handling.
  • Bug Fixes

    • Resolved issues with single validator benchmarks and node shutdowns.
    • Fixed state overwrites in debug trace APIs and removed conflicts in benchmark transactions.
  • Improvements

    • Enabled parallel generation of test transactions on a single node.
    • Implemented a retry mechanism for load generators and enhanced benchmark functionality.

@yihuang yihuang requested a review from a team as a code owner October 23, 2024 05:03
@yihuang yihuang requested review from devashishdxt and thomas-nguy and removed request for a team October 23, 2024 05:03
Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request introduces several updates across the project, primarily focusing on bug fixes and improvements. Key changes include enhancements to benchmark functionality, the addition of a new transaction checking feature in the App struct, and updates to the CHANGELOG.md to document these changes. Notable fixes address issues with validator benchmarks, node shutdown signals, and debug trace APIs. The updates also include optimizations for transaction generation and performance enhancements in specific scenarios.

Changes

File Change Summary
CHANGELOG.md Updated to include bug fixes and improvements, including validator benchmarks, node shutdown, and transaction conflicts. Added support for skipping check-tx in benchmarks.
app/app.go Added constant FlagUnsafeDummyCheckTx, field dummyCheckTx in App, and method CheckTx for enhanced transaction handling.

Possibly related PRs

Suggested reviewers

  • JayT106
  • mmsqe
  • calvinaco

🐇 In the meadow, changes bloom,
With fixes bright, dispelling gloom.
Benchmarks run with newfound grace,
Transactions checked, a faster pace.
Hops of joy, we celebrate,
In code we trust, we innovate! 🌼


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.

CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: yihuang <[email protected]>
@yihuang yihuang requested a review from mmsqe October 23, 2024 05:04
Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 34.91%. Comparing base (8a698f4) to head (d2982c0).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1659   +/-   ##
=======================================
  Coverage   34.91%   34.91%           
=======================================
  Files         123      123           
  Lines       11811    11811           
=======================================
  Hits         4124     4124           
  Misses       7273     7273           
  Partials      414      414           

@yihuang yihuang enabled auto-merge October 23, 2024 06:46
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: 0

🧹 Outside diff range and nitpick comments (2)
CHANGELOG.md (1)

20-20: Verify changelog entry format.

The changelog entry follows the standard format with bullet point, component in parentheses, PR reference, and clear description. However, consider adding more details about the benchmark improvement and its impact.

Consider expanding the entry to:

-* (testground)[#1659](https://github.com/crypto-org-chain/cronos/pull/1659) Support skip check-tx in benchmark.
+* (testground)[#1659](https://github.com/crypto-org-chain/cronos/pull/1659) Support skip check-tx in benchmark to improve performance of benchmark tests by bypassing transaction verification.
app/app.go (1)

1477-1493: Add security warning documentation for dummy check mode.

While the implementation is correct, the dummy check mode skips critical transaction validations. This could be dangerous if accidentally enabled in production.

Consider adding a code comment explaining:

  1. The security implications of enabling dummy checks
  2. That this should only be used for benchmarking
  3. The specific validations that are being skipped
+// CheckTx implements the Application.CheckTx method. It handles transaction verification
+// differently when dummy check mode is enabled.
+//
+// WARNING: Dummy check mode skips critical transaction validations and should ONLY be used
+// for benchmarking purposes. Do not enable this in production as it bypasses:
+// - Signature verification
+// - Sequence checking
+// - Fee validation
+// - Any other ABCI-level transaction checks
 func (app *App) CheckTx(req *abci.RequestCheckTx) (*abci.ResponseCheckTx, error) {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8a698f4 and d2982c0.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • app/app.go (6 hunks)
🧰 Additional context used
🔇 Additional comments (3)
CHANGELOG.md (1)

Line range hint 1-1000: LGTM - Well structured changelog.

The changelog follows best practices with:

  • Clear version sections in reverse chronological order
  • Consistent categorization of changes (Bug Fixes, Improvements, etc.)
  • PR references and descriptions for all entries
🧰 Tools
🪛 Markdownlint

22-22: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

app/app.go (2)

191-191: LGTM! Flag naming follows convention.

The FlagUnsafeDummyCheckTx constant follows the established naming pattern for unsafe flags and clearly indicates its testing/benchmarking purpose.


357-359: LGTM! Field addition with appropriate documentation.

The dummyCheckTx field is well-documented with a clear warning about validator usage restrictions.

@yihuang yihuang added this pull request to the merge queue Oct 23, 2024
Merged via the queue into crypto-org-chain:main with commit 1ae61b4 Oct 23, 2024
46 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.

2 participants