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

Add additional tests and comments for Transfer Authz #6484

Conversation

chatton
Copy link
Contributor

@chatton chatton commented Jun 4, 2024

Description

closes: #6474


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

  • Bug Fixes

    • Improved handling of spend limits and allocation deletion when limits are exceeded or denominations are not in the allocation.
  • Tests

    • Enhanced test coverage for multidenom transfers, including scenarios for spend limits and invalid denominations.

Copy link
Contributor

coderabbitai bot commented Jun 4, 2024

Walkthrough

The changes in the TransferAuthorization type and its associated tests focus on simplifying the code by removing intermediate variables and directly accessing fields within the Allocations slice. The modifications also include adding comprehensive test cases for various scenarios, such as multidenom transfers and spend limit validations.

Changes

File Path Change Summary
modules/.../transfer_authorization.go Simplified Accept method by removing intermediate variables and directly updating Allocations.
modules/.../transfer_authorization_test.go Added new test cases for multidenom transfers, spend limit checks, and handling edge cases.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant TransferAuthorization
    participant Allocation

    User->>TransferAuthorization: Call Accept with msg
    TransferAuthorization->>Allocation: Directly access fields in Allocations[index]
    Allocation-->>TransferAuthorization: Update SpendLimit
    TransferAuthorization->>User: Return result
Loading

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Cover all cases in transfer_authz tests (#6474)
Update Transfer Authz for multi-denom support (#5802)

Possibly related issues


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.
    • @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 as 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.

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.

@@ -71,47 +72,6 @@ func (suite *TypesTestSuite) TestTransferAuthorizationAccept() {
suite.Require().Nil(res.Updated)
},
},
{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

moved down to have multi denom tests together

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c267104 and 5556618.

Files selected for processing (2)
  • modules/apps/transfer/types/transfer_authorization.go (3 hunks)
  • modules/apps/transfer/types/transfer_authorization_test.go (3 hunks)
Additional context used
Path-based instructions (2)
modules/apps/transfer/types/transfer_authorization.go (1)

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

modules/apps/transfer/types/transfer_authorization_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 (7)
modules/apps/transfer/types/transfer_authorization.go (4)

57-57: LGTM! The check for allowed receiver addresses enhances security.


61-61: Good addition of memo validation to ensure data integrity.


Line range hint 73-85: Proper handling of unbounded spend limits ensures robustness in spend limit logic.


89-90: Efficient cleanup of zero spend limit allocations helps maintain state integrity.

modules/apps/transfer/types/transfer_authorization_test.go (3)

12-12: Necessary import of ibcerrors for handling specific error types in tests.


211-248: Comprehensive test case added for handling multiple allocations and multidenom transfers, enhancing coverage.


250-319: Important test cases added for error handling when spend limits are exceeded or denominations are not in the allocation.

Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

🔥

@crodriguezvega crodriguezvega added the priority PRs that need prompt reviews label Jun 5, 2024
Copy link
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

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

Nice! Thank you @chatton 🙏

@chatton chatton enabled auto-merge (squash) June 5, 2024 10:47
Copy link

sonarcloud bot commented Jun 5, 2024

Quality Gate Failed Quality Gate failed for 'ibc-go'

Failed conditions
59.1% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

@chatton chatton merged commit a7ddab9 into main Jun 5, 2024
74 of 75 checks passed
@chatton chatton deleted the cian/issue#6474-look-into-transfer_authz-code-and-write-tests-to-cover-all-cases branch June 5, 2024 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority PRs that need prompt reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Look into transfer_authz code and write tests to cover all cases.
4 participants