celestiaorg / celestia-app

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

refactor: rename limits from tx to msg #3984

Closed rootulp closed 1 month ago

rootulp commented 1 month ago

Motivation: https://github.com/celestiaorg/CIPs/pull/220#discussion_r1803281819

IMO we should either include this in v3.0.0-rc0 or close it b/c not worth it to break these constant names after that.

coderabbitai[bot] commented 1 month ago
📝 Walkthrough ## Walkthrough The changes in this pull request involve renaming constants and updating logic related to transaction limits in the context of message handling. Specifically, constants `PFBTransactionCap` and `NonPFBTransactionCap` have been renamed to `MaxPFBMessages` and `MaxNonPFBMessages`, respectively. The test file `prepare_proposal_test.go` has been updated to reflect these changes, ensuring that the tests accurately assert the number of messages against the new limits. Additionally, the transaction filtering logic in `validate_txs.go` has been modified to align with the new naming conventions. ## Changes | File Path | Change Summary | |-------------------------------------|-----------------------------------------------------------------------------------------------------| | app/test/prepare_proposal_test.go | Renamed constants related to transaction limits; updated `TestPrepareProposalCappingNumberOfMessages` to use new constants. | | app/validate_txs.go | Renamed variables in `filterStdTxs` and `filterBlobTxs` functions; updated logic to use new constants for message counts. | | pkg/appconsts/global_consts.go | Renamed constants `NonPFBTransactionCap` to `MaxNonPFBMessages` and `PFBTransactionCap` to `MaxPFBMessages`; updated comments. | ## Possibly related PRs - **#3942**: This PR directly relates to the main PR as it also modifies the `app/test/prepare_proposal_test.go` file to add new tests for capping the number of messages in proposals, which aligns with the changes made in the main PR regarding transaction limits. - **#3967**: This PR is relevant because it involves renaming `MaxTxBytes` to `MaxTxSize` in multiple files, including `app/test/prepare_proposal_test.go`, which reflects the changes made in the main PR regarding transaction limit constants. ## Suggested labels `WS: Maintenance 🔧`, `external` ## Suggested reviewers - evan-forbes - ninabarbakadze - liamsi - staheri14

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

Thoughts @evan-forbes ? It's technically breaking but it's a really small constant rename and there are no downstream users of the old constants (yet).

evan-forbes commented 1 month ago

I think its fine to include