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

imp: check length of slices of messages #6256

Merged
merged 6 commits into from
May 8, 2024

Conversation

crodriguezvega
Copy link
Contributor

@crodriguezvega crodriguezvega commented May 5, 2024

Description

Adds length checking of array fields in messages.

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • New Features

    • Introduced maximum length validations for various parameters in the interchain accounts and client connections modules to enhance system stability and data integrity.
    • Added constants for maximum allowable lengths in interchain accounts and client connections.
  • Bug Fixes

    • Implemented validation checks to prevent excessive input lengths that could lead to system errors.
  • Tests

    • Added comprehensive test cases to verify the new validation rules for parameters and connection attempts, ensuring robustness and reliability.

Copy link
Contributor

coderabbitai bot commented May 5, 2024

Warning

Rate Limit Exceeded

@crodriguezvega has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 40 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 964a64b and f01e381.

Walkthrough

The recent updates across various modules primarily involve adding new constants for maximum lengths and updating validation functions to enforce these limits. These changes ensure that parameters like allowed message types, client lists, and version features do not exceed predefined thresholds, enhancing system stability and security. Corresponding test cases have also been added to verify these new validations.

Changes

File Path Change Summary
.../host/types/params.go, .../host/types/params_test.go Added MaxAllowListLength constant and updated/testing validation for allowlist length.
.../02-client/types/params.go, .../02-client/types/params_test.go Introduced MaxAllowedClientsLength constant and added validation/test for client list length.
.../03-connection/types/msgs.go, .../03-connection/types/msgs_test.go, .../03-connection/types/version.go Added checks and tests for CounterpartyVersions and Features length limits in connection messages and versions.

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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 4f02df5 and ace9cf0.
Files selected for processing (7)
  • modules/apps/27-interchain-accounts/host/types/params.go (2 hunks)
  • modules/apps/27-interchain-accounts/host/types/params_test.go (1 hunks)
  • modules/core/02-client/types/params.go (2 hunks)
  • modules/core/02-client/types/params_test.go (1 hunks)
  • modules/core/03-connection/types/msgs.go (1 hunks)
  • modules/core/03-connection/types/msgs_test.go (1 hunks)
  • modules/core/03-connection/types/version.go (2 hunks)
Additional Context Used
Path-based Instructions (7)
modules/apps/27-interchain-accounts/host/types/params_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

modules/apps/27-interchain-accounts/host/types/params.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/core/02-client/types/params_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

modules/core/02-client/types/params.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/core/03-connection/types/version.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/core/03-connection/types/msgs.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

modules/core/03-connection/types/msgs_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (9)
modules/apps/27-interchain-accounts/host/types/params.go (2)

13-13: The constant MaxAllowListLength is well-defined and appropriately used in the validation logic.


35-37: The updated validation logic correctly checks for the maximum length constraint.

modules/core/02-client/types/params_test.go (1)

43-43: The test case effectively checks the behavior when the number of allowed clients exceeds the new limit.

modules/core/02-client/types/params.go (2)

10-10: The constant MaxAllowedClientsLength is well-defined and appropriately used in the validation logic.


52-54: The updated validation logic correctly checks for the maximum length constraint.

modules/core/03-connection/types/version.go (2)

32-34: The constants MaxCounterpartyVersionsLength and MaxFeaturesLength are well-defined and appropriately used in the validation logic.


64-66: The updated validation logic correctly checks for the maximum length constraint on features.

modules/core/03-connection/types/msgs.go (1)

132-134: The updated ValidateBasic method correctly checks for the maximum length constraint on CounterpartyVersions.

modules/core/03-connection/types/msgs_test.go (1)

163-165: The test case effectively checks the behavior when the number of CounterpartyVersions exceeds the new limit.

@@ -14,4 +14,5 @@ func TestValidateParams(t *testing.T) {
require.Error(t, types.NewParams(true, []string{""}).Validate())
require.Error(t, types.NewParams(true, []string{" "}).Validate())
require.Error(t, types.NewParams(true, []string{"*", "/cosmos.bank.v1beta1.MsgSend"}).Validate())
require.Error(t, types.NewParams(true, make([]string, 1000)).Validate())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure the test covers the edge case where the length is exactly at the maximum allowable limit.

Would you like me to help add this test case?

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

Out of diff range and nitpick comments (2)
CHANGELOG.md (2)

Line range hint 169-169: Ensure URLs are properly formatted with descriptive text.

- * [\#6193](https://github.com/cosmos/ibc-go/pull/6193) Bump Cosmos SDK to v0.50.6.
+ * [Bump Cosmos SDK to v0.50.6](https://github.com/cosmos/ibc-go/pull/6193).

Line range hint 184-184: Remove trailing spaces to maintain clean and professional code documentation.

- * (apps/27-interchain-accounts) [\#5533](https://github.com/cosmos/ibc-go/pull/5533) ICA host sets the host connection ID on `OnChanOpenTry`, so that ICA controller implementations are not obliged to set the value on `OnChanOpenInit` if they are not able. 
+ * (apps/27-interchain-accounts) [\#5533](https://github.com/cosmos/ibc-go/pull/5533) ICA host sets the host connection ID on `OnChanOpenTry`, so that ICA controller implementations are not obliged to set the value on `OnChanOpenInit` if they are not able.
Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between ace9cf0 and 91c6260.
Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • modules/apps/27-interchain-accounts/host/types/params_test.go (1 hunks)
  • modules/core/02-client/types/params_test.go (1 hunks)
  • modules/core/03-connection/types/msgs_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • modules/apps/27-interchain-accounts/host/types/params_test.go
  • modules/core/02-client/types/params_test.go
  • modules/core/03-connection/types/msgs_test.go
Additional Context Used
Path-based Instructions (1)
CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed previously, maximums seem somewhat arbitrary and there should be protection from cosmos-sdk max tx size limits as well as the gas costs incurred from such a large spam type message.

Approving for extra defensive parameter checks regardless 👍🏻

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

Out of diff range and nitpick comments (2)
CHANGELOG.md (2)

Line range hint 170-170: Remove the bare URL and replace it with a markdown link.

- * [\#6193](https://github.com/cosmos/ibc-go/pull/6193) Bump Cosmos SDK to v0.50.6.
+ * [\#6193](https://github.com/cosmos/ibc-go/pull/6193) Bump Cosmos SDK to v0.50.6.

Line range hint 185-185: Remove trailing spaces.

- * (apps/27-interchain-accounts) [\#5533](https://github.com/cosmos/ibc-go/pull/5533) ICA host sets the host connection ID on `OnChanOpenTry`, so that ICA controller implementations are not obliged to set the value on `OnChanOpenInit` if they are not able.
+ * (apps/27-interchain-accounts) [\#5533](https://github.com/cosmos/ibc-go/pull/5533) ICA host sets the host connection ID on `OnChanOpenTry`, so that ICA controller implementations are not obliged to set the value on `OnChanOpenInit` if they are not able.
Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 91c6260 and 964a64b.
Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Additional Context Used
Path-based Instructions (1)
CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Copy link

sonarqubecloud bot commented May 7, 2024

Quality Gate Passed Quality Gate passed for 'ibc-go'

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@crodriguezvega crodriguezvega merged commit 478f4c6 into main May 8, 2024
86 of 88 checks passed
@crodriguezvega crodriguezvega deleted the carlos/check-lengths-slices branch May 8, 2024 08:08
mergify bot pushed a commit that referenced this pull request May 8, 2024
* imp: check length of slices of messages

* add changelog

* change test limits

(cherry picked from commit 478f4c6)

# Conflicts:
#	CHANGELOG.md
#	modules/apps/27-interchain-accounts/host/types/params.go
#	modules/apps/27-interchain-accounts/host/types/params_test.go
#	modules/core/02-client/types/params.go
#	modules/core/02-client/types/params_test.go
mergify bot pushed a commit that referenced this pull request May 8, 2024
* imp: check length of slices of messages

* add changelog

* change test limits

(cherry picked from commit 478f4c6)

# Conflicts:
#	CHANGELOG.md
#	modules/apps/27-interchain-accounts/host/types/params.go
#	modules/apps/27-interchain-accounts/host/types/params_test.go
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants