[OTE-779] Check affiliate tiers are strictly increasing before updating tiers #2220

affanv14 · 2024-09-06T13:53:03Z

Changelist

Checks volume and staking requirements are strictly increasing in affiliate tiers

Test Plan

Added unit test

Author/Reviewer Checklist

If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

New Features
- Enhanced error handling and validation for updating affiliate tiers.
- Introduced checks to ensure affiliate tiers are strictly increasing based on defined criteria.
Bug Fixes
- Improved test coverage for the UpdateAffiliateTiers method to capture and assert errors during tier updates.
Tests
- Restructured test cases to validate both valid and invalid configurations of affiliate tiers, ensuring adherence to business rules.
- Enhanced error handling in test functions to ensure proper reporting of issues during tier updates.
- Improved error management in the messaging server for tier updates.

linear · 2024-09-06T13:53:06Z

OTE-779 Check strictly increasing volume and staking requirements hold in UpdateAffiliateTiers

coderabbitai · 2024-09-06T13:53:25Z

Walkthrough

The changes involve significant updates to the UpdateAffiliateTiers function in the Keeper struct, enhancing its error handling and validation logic. The function now returns an error type, checks for marshaling errors, and validates that affiliate tiers are strictly increasing. Corresponding updates were made to the tests in keeper_test.go and grpc_query_test.go to ensure errors are properly handled and validated against various scenarios. Additionally, the msgServer struct's method for updating affiliate tiers was modified to include error handling.

Changes

Files	Change Summary
`protocol/x/affiliates/keeper/keeper.go`	Updated `UpdateAffiliateTiers` to return an `error`, added error checking for marshaling, and implemented validation for strictly increasing affiliate tiers.
`protocol/x/affiliates/keeper/keeper_test.go`, `protocol/x/affiliates/keeper/grpc_query_test.go`	Enhanced tests to check for errors in `UpdateAffiliateTiers`, validating various tier configurations and ensuring robustness in error handling and validation.
`protocol/x/affiliates/keeper/msg_server.go`	Introduced error handling in `UpdateAffiliateTiers` method of `msgServer`, ensuring errors from the keeper are captured and communicated properly.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure error handling for affiliate tiers (undefined)	✅
Validate that affiliate tiers are strictly increasing (undefined)	✅

Possibly related issues

None identified.

Possibly related PRs

[OTE-692] Implement message server for affiliates #2216: This PR modifies the UpdateAffiliateTiers function to include error handling and business logic, indicating a direct relationship in functionality.
[OTE-730] add test to check register affiliate auth #2235: This PR adds tests for the RegisterAffiliate function, which is closely related to the UpdateAffiliateTiers function in terms of affiliate management.

Suggested labels

indexer, feature:indexer/affiliates

🐰 "In the fields where the tiers do rise,
A keeper checks with watchful eyes.
With every step, they must be fair,
No dips or drops, just heights to share.
So hop along, let's celebrate,
For order's kept, and that's just great!" 🐇

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 388ee23 and f5870b1.

Files selected for processing (1)

protocol/x/affiliates/keeper/msg_server.go (1 hunks)

Additional comments not posted (1)

protocol/x/affiliates/keeper/msg_server.go (1)

54-57: LGTM!

The error handling mechanism is correctly implemented. The method now properly checks for any errors returned by k.Keeper.UpdateAffiliateTiers and returns nil along with the error if one occurs. This enhances the robustness of the function by ensuring that any issues during the update process are properly handled and communicated.

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 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.

CodeRabbit Configuration 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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0ce92b3 and a326931.

Files selected for processing (2)

protocol/x/affiliates/keeper/keeper.go (1 hunks)
protocol/x/affiliates/keeper/keeper_test.go (4 hunks)

Additional comments not posted (2)

protocol/x/affiliates/keeper/keeper.go (1)

221-238: Comprehensive update to UpdateAffiliateTiers function.

The modifications to the UpdateAffiliateTiers function enhance its robustness by introducing error handling for marshaling and validation to ensure that tier requirements are strictly increasing. These changes are crucial for maintaining the integrity of the affiliate tier structure and provide clear error feedback, which is essential for debugging and maintenance.

Error Handling: The function now properly handles marshaling errors by wrapping them with a contextual error message, which aids in troubleshooting.

Validation Logic: The validation ensures that each tier's requirements do not decrease, which is vital for the system's operational integrity.

Overall, these changes significantly improve the function's reliability and adherence to business rules.

protocol/x/affiliates/keeper/keeper_test.go (1)

302-349: Enhanced testing for UpdateAffiliateTiers.

The TestUpdateAffiliateTiers function has been significantly improved to include comprehensive test cases that validate both valid and invalid configurations of affiliate tiers. This enhancement is crucial for ensuring the robustness of the tier update functionality.

Test Coverage: The test cases effectively cover scenarios where tier requirements are either correctly increasing or incorrectly set, which helps in ensuring that the business logic is adhered to strictly.

Assertions: The use of require.NoError for expected successful updates and require.ErrorIs for expected failures due to invalid configurations ensures that the tests are both precise and informative.

These changes greatly enhance the reliability of the tests and by extension, the affiliate tier update functionality.

teddyding · 2024-09-09T18:19:41Z

protocol/x/affiliates/keeper/keeper.go

-	// TODO(OTE-779): Check strictly increasing volume and
-	// staking requirements hold in UpdateAffiliateTiers
-	store.Set([]byte(types.AffiliateTiersKey), k.cdc.MustMarshal(&affiliateTiers))
+	affiliateTiersBytes, err := k.cdc.Marshal(&affiliateTiers)


Nit: use k.cdc.MustMarshal

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a326931 and 47805e1.

Files selected for processing (1)

protocol/x/affiliates/keeper/keeper.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

protocol/x/affiliates/keeper/keeper.go

affanv14 requested a review from a team as a code owner September 6, 2024 13:53

github-actions bot added the protocol label Sep 6, 2024

coderabbitai bot reviewed Sep 6, 2024

View reviewed changes

teddyding reviewed Sep 9, 2024

View reviewed changes

teddyding approved these changes Sep 9, 2024

View reviewed changes

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

affanv14 added 3 commits September 12, 2024 16:58

Check affiliate tiers are strictly increasing before updating tiers

3b8e68e

fix nit

1e8fd08

fix ci

388ee23

github-actions bot added indexer proto labels Sep 12, 2024

affanv14 force-pushed the affan/update-affiliate-check branch from 6b88537 to 388ee23 Compare September 12, 2024 21:05

github-actions bot removed indexer proto labels Sep 12, 2024

lint

f5870b1

teddyding approved these changes Sep 13, 2024

View reviewed changes

affanv14 merged commit 759498f into main Sep 13, 2024
22 checks passed

affanv14 deleted the affan/update-affiliate-check branch September 13, 2024 15:41

This was referenced Sep 23, 2024

[OTE-817] update trading rewards with new logic #2300

Merged

[OTE-829] upgrade handler for affiliates #2332

Merged

teddyding added the feature:x/affiliates label Dec 3, 2024

This was referenced Dec 5, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation #2623

Merged

fix(affiliates): Reject self referral in RegisterAffiliate #2637

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OTE-779] Check affiliate tiers are strictly increasing before updating tiers #2220

[OTE-779] Check affiliate tiers are strictly increasing before updating tiers #2220

affanv14 commented Sep 6, 2024 •

edited by coderabbitai bot

Loading

linear bot commented Sep 6, 2024

coderabbitai bot commented Sep 6, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

teddyding Sep 9, 2024

coderabbitai bot left a comment

[OTE-779] Check affiliate tiers are strictly increasing before updating tiers #2220

[OTE-779] Check affiliate tiers are strictly increasing before updating tiers #2220

Conversation

affanv14 commented Sep 6, 2024 • edited by coderabbitai bot Loading

Changelist

Test Plan

Author/Reviewer Checklist

Summary by CodeRabbit

linear bot commented Sep 6, 2024

coderabbitai bot commented Sep 6, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related issues

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

teddyding Sep 9, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

affanv14 commented Sep 6, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 6, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)