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

fix: remove recipient amount from map #20625

Merged
merged 9 commits into from
Jun 13, 2024
Merged

fix: remove recipient amount from map #20625

merged 9 commits into from
Jun 13, 2024

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Jun 11, 2024

Description

when canceling a fund the percentage was not removed from the map


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in the CancelContinuousFund method to ensure recipient fund percentage and distribution are correctly removed before returning a response.
  • Refactor

    • Updated the data structure for funds distribution calculation to use a list of recipientFund structs, enhancing the iteration and update logic.
  • Tests

    • Enhanced test coverage for CancelContinuousFund, including additional operations and error handling for multiple recipients.

Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The recent updates to the x/protocolpool module enhance error handling and modify the structure for managing funds distribution. Specifically, these changes include improved error handling in the CancelContinuousFund method and a shift from using a map to a list of structs for recipient funds. These updates aim to improve reliability and maintainability of fund distribution logic.

Changes

Files Change Summary
x/protocolpool/keeper/msg_server.go Enhanced error handling in CancelContinuousFund method to remove recipient fund percentage and distribution before returning a response.
x/protocolpool/keeper/msg_server_test.go Added recipient3 and related operations in TestCancelContinuousFund, including setting and checking funds, and adjusted error handling.
x/protocolpool/keeper/keeper.go Introduced recipientFund struct, replaced map with a list of recipientFund structs, and updated the logic for funds distribution calculation.

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.

@tac0turtle tac0turtle marked this pull request as ready for review June 11, 2024 15:03
@tac0turtle tac0turtle requested a review from a team as a code owner June 11, 2024 15:03
Copy link
Contributor

@alpe alpe left a comment

Choose a reason for hiding this comment

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

Good work.
I don't have the full context on this module but the changes do the opposite steps to the create function

x/protocolpool/keeper/msg_server.go Outdated Show resolved Hide resolved
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 (1)
x/protocolpool/keeper/msg_server_test.go (1)

Line range hint 813-963: The addition of recipient3 in the TestCancelContinuousFund function is well-implemented and covers the necessary scenarios to ensure the CancelContinuousFund method behaves as expected with multiple recipients.

Consider adding more edge cases, such as simultaneous cancellation requests or rapid sequence operations, to ensure robustness under stress or race conditions.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 150ca96 and 9eda268.

Files selected for processing (2)
  • x/protocolpool/keeper/msg_server.go (1 hunks)
  • x/protocolpool/keeper/msg_server_test.go (3 hunks)
Additional context used
Path-based instructions (2)
x/protocolpool/keeper/msg_server.go (1)

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

x/protocolpool/keeper/msg_server_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 (1)
x/protocolpool/keeper/msg_server.go (1)

204-210: The changes to remove recipient fund percentage and distribution upon fund cancellation are correctly implemented.

Ensure that the removal of these items does not affect other parts of the system that might rely on this data being present until a certain point in the transaction lifecycle.

#!/bin/bash
# Description: Verify that no other parts of the system are affected by the early removal of fund data.

# Test: Search for any other references to `RecipientFundPercentage` and `RecipientFundDistribution` that might expect these to exist post-cancellation.
rg --type go $'RecipientFundPercentage|RecipientFundDistribution'

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 9eda268 and b161886.

Files selected for processing (1)
  • x/protocolpool/keeper/msg_server.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/protocolpool/keeper/msg_server.go

@tac0turtle tac0turtle requested a review from alpe June 12, 2024 15:50
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 (1)
x/protocolpool/keeper/keeper.go (1)

Line range hint 261-306: The iterateAndUpdateFundsDistribution function has been refactored to use the new recipientFund struct. Ensure that the total percentage calculation is correctly implemented as it seems to be missing in the current logic.

- totalPercentageToBeDistributed := math.ZeroInt()
+ totalPercentageToBeDistributed := math.ZeroInt()
+ for _, fund := range recipientFundList {
+     totalPercentageToBeDistributed = totalPercentageToBeDistributed.Add(fund.Percentage)
+ }
Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b161886 and 40ad64e.

Files selected for processing (1)
  • x/protocolpool/keeper/keeper.go (2 hunks)
Additional context used
Path-based instructions (1)
x/protocolpool/keeper/keeper.go (1)

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

Additional comments not posted (1)
x/protocolpool/keeper/keeper.go (1)

257-260: Introduced recipientFund struct to manage recipient addresses and their corresponding percentages.

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 40ad64e and e22ea16.

Files selected for processing (1)
  • x/protocolpool/keeper/keeper.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/protocolpool/keeper/keeper.go

@tac0turtle tac0turtle added this pull request to the merge queue Jun 12, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jun 12, 2024
@tac0turtle tac0turtle added this pull request to the merge queue Jun 13, 2024
Merged via the queue into main with commit a6844f5 Jun 13, 2024
64 of 65 checks passed
@tac0turtle tac0turtle deleted the marko/remove_recp_ branch June 13, 2024 08:13
alpe added a commit that referenced this pull request Jun 13, 2024
* main:
  fix(x/staking): stop validators from rotating to the same key on the same block (#20649)
  perf: add cache to address codec (#20122)
  build(deps): Bump google.golang.org/protobuf from 1.34.1 to 1.34.2 (#20632)
  fix: remove recipient amount from map (#20625)
  fix(proto): remove conditional preventing proper generated file placement (#20650)
  (serverv2/cometbft) Read config from commands & handle `FlagNode` (#20621)
  fix(x/consensus): fix .proto file placement (#20646)
  fix(store): avoid nil error on not exhausted payload stream (#20644)
  fix (x/accounts): Fix genesis condition check (#20645)
  feat(accounts): add genesis account initialization (#20642)
  fix(x/gov): limit execution in gov (#20348)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants