celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
345 stars 292 forks source link

feat!: limit the max tx size to 2 MiB #3909

Closed ninabarbakadze closed 1 month ago

ninabarbakadze commented 1 month ago

Overview

Fixes #3686

github-actions[bot] commented 1 month ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-3909/ on branch gh-pages at 2024-10-11 16:25 UTC

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes introduce a new decorator, `MaxTxSizeDecorator`, to the transaction handling process, ensuring transactions do not exceed a specified size limit. This decorator is added to the `NewAnteHandler` function, which is responsible for processing transactions. Additionally, a new constant `MaxTxBytes` is defined to set the maximum transaction size, and corresponding tests have been implemented to validate the decorator's functionality across various scenarios. ## Changes | File | Change Summary | |--------------------------------------|---------------------------------------------------------------------------------------------------------| | app/ante/ante.go | Added `NewMaxTxSizeDecorator()` to `NewAnteHandler` for transaction size validation. | | app/ante/max_tx_size.go | Introduced `MaxTxSizeDecorator` type with `AnteHandle` method to enforce transaction size limits. | | app/ante/max_tx_size_test.go | Created tests for `MaxTxSizeDecorator` to validate behavior with various transaction sizes and versions. | | pkg/appconsts/v3/app_consts.go | Added constant `MaxTxBytes` set to 2097152 (2 MiB). | | pkg/appconsts/versioned_consts.go | Added function `MaxTxBytes` to return the value of `v3.MaxTxBytes`. | | app/process_proposal.go | Modified to set transaction bytes in context for application versions 3 and above. | | app/validate_txs.go | Modified `filterStdTxs` and `filterBlobTxs` to set transaction size on context. | ## Assessment against linked issues | Objective | Addressed | Explanation | |---------------------------------------------------------|-----------|----------------------------------------------------------| | Cap the size of the transaction to reduce strain on network (#3686) | ✅ | | ## Possibly related PRs - **#3954**: The changes in this PR involve updates to the `ProcessProposal` method and the `prepare_proposal_test.go` file, which are directly related to the modifications made in the main PR regarding transaction processing and size management. ## Suggested labels `enhancement`, `WS: Big Blonks 🔭`, `WS: Maintenance 🔧` ## Suggested reviewers - rootulp - evan-forbes - cmwaters

📜 Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 70b4174cdb44cabb1f9d4d9ba6a6596af4eb24df and f6002273be2acb7293d41bb16c93381c0dda7af9.
📒 Files selected for processing (1) * app/test/prepare_proposal_test.go (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * app/test/prepare_proposal_test.go
--- 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): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
rootulp commented 1 month ago

Another nit: PR title could be more readable to end-users b/c it will show up in release notes. For example: "feat!: limit the max tx size to 2 MiB".

Can also add this to release notes.

ninabarbakadze commented 1 month ago

Another nit: PR title could be more readable to end-users b/c it will show up in release notes. For example: "feat!: limit the max tx size to 2 MiB".

Can also add this to release notes.

Thanks @rootulp! Updated :)

ninabarbakadze commented 1 month ago

lint is failing: https://github.com/celestiaorg/celestia-app/actions/runs/11278126505/job/31365885695?pr=3909#step:5:30

test-short is failing: https://github.com/celestiaorg/celestia-app/actions/runs/11278126505/job/31365889567?pr=3909#step:4:219

oops my local linter seems to be not working. one sec!