fix: superfluid log for error that should be ignored #8791

PaddyMc · 2024-10-30T11:41:08Z

What is the purpose of the change

When we call the WithdrawDelegatorRewards function, we expect there to be a certain type of error, but this error changed in v50 causing multiple info logs that should be debug logs, making it difficult to understand what's happening with the superfluid epoch.

For v0.50 a function changed to return a different error see:
https://github.com/osmosis-labs/cosmos-sdk/blob/osmo-v27/0.50.10/x/distribution/keeper/keeper.go#L107-L138

old v0.47 see:
https://github.com/osmosis-labs/cosmos-sdk/blob/osmo-v25/v0.47.5/x/distribution/keeper/keeper.go#L83-L103

Testing and Verifying

Run all go tests for superfluid

see (live debug logs):

11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
> github.com/cosmos/cosmos-sdk/x/distribution/keeper.Keeper.WithdrawDelegationRewards() /home/ghost/go/pkg/mod/github.com/osmosis-labs/[email protected]/x/distribution/keeper/keeper.go:118 (PC: 0x540fca4)
   113:		if val == nil {
   114:			return nil, types.ErrNoValidatorDistInfo
   115:		}
   116:	
   117:		del, err := k.stakingKeeper.Delegation(ctx, delAddr, valAddr)
=> 118:		if err != nil {
   119:			return nil, err
   120:		}
   121:	
   122:		if del == nil {
   123:			return nil, types.ErrEmptyDelegationDistInfo
(dlv) p err
error(*cosmossdk.io/errors.Error) *{
	codespace: "staking",
	code: 19,
	desc: "no delegation for (address, validator) tuple",
	grpcCode: Unknown (2),}

&&

11:14AM ERR no delegation for (address, validator) tuple module=server
11:14AM ERR no delegation for (address, validator) tuple module=server
> github.com/cosmos/cosmos-sdk/x/distribution/keeper.Keeper.WithdrawDelegationRewards() /home/ghost/go/pkg/mod/github.com/osmosis-labs/[email protected]/x/distribution/keeper/keeper.go:122 (hits goroutine(450):7 total:7) (PC: 0x540fd01)
   117:		del, err := k.stakingKeeper.Delegation(ctx, delAddr, valAddr)
   118:		if err != nil {
   119:			return nil, err
   120:		}
   121:	
=> 122:		if del == nil {
   123:			return nil, types.ErrEmptyDelegationDistInfo
   124:		}
   125:

coderabbitai · 2024-10-30T11:52:28Z

Walkthrough

The changes in this pull request involve updates to the CHANGELOG.md file, which now includes new entries under the "Unreleased" section for various categories such as "State Breaking," "Config," and "State Compatible." Additionally, the x/superfluid/keeper/epoch.go file has been modified to improve error handling in the MoveSuperfluidDelegationRewardToGauges method by adding a new error check for stakingtypes.ErrNoDelegation. This enhances the robustness of the error handling without altering the core functionality.

Changes

File Path	Change Summary
CHANGELOG.md	Updated with new entries in "State Breaking," "Config," and "State Compatible" categories; includes version bumps and bug fixes.
x/superfluid/keeper/epoch.go	Added import for `stakingtypes` and included a new error check for `stakingtypes.ErrNoDelegation` in `MoveSuperfluidDelegationRewardToGauges`.

Possibly related PRs

chore: changelog fixes #8423: This PR also involves updates to the CHANGELOG.md, focusing on fixing entries and ensuring accurate documentation of changes.
chore: update changelog for v25.2.1 #8552: Similar to the main PR, this PR updates the CHANGELOG.md to reflect recent changes and enhancements, indicating a direct connection in terms of documentation updates.
chore: updating binary json file #8698: This PR updates the CHANGELOG.md to include new entries, including a version bump for cosmwasm-optimizer, which aligns with the changes made in the main PR.
fix: iterate delegations continue instead of erroring #8732: This PR includes a changelog entry for a fix related to delegation iteration, which is also documented in the main PR's changelog updates.
fix: state export for gov module constitution #8777: This PR adds a changelog entry for a fix related to the governance module, which is relevant to the updates made in the main PR's changelog.
chore: bump cometbft/cosmos-sdk versions #8779: This PR includes a changelog entry for the bump of cometbft/cosmos-sdk versions, which is related to the dependency updates mentioned in the main PR.

Suggested reviewers

czarcas7ic
PaddyMc
AlpinYukseloglu

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>, please review it.
- 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 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.

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

🧹 Outside diff range and nitpick comments (1)

x/superfluid/keeper/epoch.go (1)

83-88: Consider implementing the TODO for performance optimization.

Both error handling blocks contain a TODO about removing accounts from IntermediaryAccounts to avoid unnecessary iterations. This optimization could improve performance, especially with a large number of accounts.

Would you like me to create a GitHub issue to track this optimization task?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2e85d1e and cdc98b0.

📒 Files selected for processing (2)

CHANGELOG.md (1 hunks)
x/superfluid/keeper/epoch.go (2 hunks)

🔇 Additional comments (3)

x/superfluid/keeper/epoch.go (2)

10-10: LGTM: Import addition is appropriate.

The addition of the stakingtypes import is necessary for the new error handling and follows proper import conventions.

84-88: LGTM: Error handling enhancement aligns with v0.50.x changes.

The addition of stakingtypes.ErrNoDelegation check properly addresses the v0.50.x error handling changes while maintaining consistent behavior. The debug log level is appropriate for this expected condition.

Let's verify that this is the only place where we need to handle this error type:

✅ Verification successful

Let me check the error handling in the other location that calls WithdrawDelegationRewards.

Let me try a different approach to check the error handling:

Error handling for stakingtypes.ErrNoDelegation is correctly implemented only where needed

The error handling change in x/superfluid/keeper/epoch.go is appropriate and sufficient. The other usage of WithdrawDelegationRewards in x/valset-pref module has different error handling requirements since:

It operates on validated delegator-validator pairs from GetValSetPreferencesWithDelegations
It propagates errors directly as it's part of a user-initiated transaction, unlike the superfluid module's background epoch processing

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other potential places where stakingtypes.ErrNoDelegation should be handled
rg "WithdrawDelegationRewards" --type go

Length of output: 9909

Script:

# Check error handling in valset-pref module
ast-grep --pattern 'WithdrawDelegationRewards($$$) {
  $$$
}'

Length of output: 63

Script:

#!/bin/bash
# Check the implementation in valset-pref module
rg "WithdrawDelegationRewards" -A 10 x/valset-pref/validator_set.go

Length of output: 1524

CHANGELOG.md (1)

68-68: LGTM: Changelog entry properly documents the PR changes.

The changelog entry correctly captures the purpose of PR #8791 to fix superfluid logging behavior. The entry is appropriately placed under the "State Compatible" section since it's a non-state-breaking change.

fix: superfluid log for error that should be ignored

6dcde5b

PaddyMc requested review from mattverse and AlpinYukseloglu as code owners October 30, 2024 11:41

github-actions bot added the C:x/superfluid label Oct 30, 2024

PaddyMc added the V:state/compatible/no_backport State machine compatible PR, depends on prior breaks label Oct 30, 2024

chore: changelog update

cdc98b0

coderabbitai bot reviewed Oct 30, 2024

View reviewed changes

ValarDragon approved these changes Oct 30, 2024

View reviewed changes

ValarDragon merged commit 650a25c into main Oct 30, 2024
1 check passed

ValarDragon deleted the fix/error-log-in-superfluid-epoch branch October 30, 2024 13:29

coderabbitai bot mentioned this pull request Nov 4, 2024

chore: update tagged submodules for v27 #8801

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: superfluid log for error that should be ignored #8791

fix: superfluid log for error that should be ignored #8791

PaddyMc commented Oct 30, 2024 •

edited

Loading

coderabbitai bot commented Oct 30, 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

fix: superfluid log for error that should be ignored #8791

fix: superfluid log for error that should be ignored #8791

Conversation

PaddyMc commented Oct 30, 2024 • edited Loading

What is the purpose of the change

Testing and Verifying

coderabbitai bot commented Oct 30, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

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

PaddyMc commented Oct 30, 2024 •

edited

Loading

coderabbitai bot commented Oct 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)