refactor(x/staking): return errors on Hooks calls

[likhita-809]

Description

Closes: #17843

---

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

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

• Refactor
  • Enhanced error handling across multiple methods to return errors for improved reliability and debugging. Replaced logging with formatted error messages and adjusted return types where necessary.

[coderabbitai]

Walkthrough

The recent changes in the Cosmos SDK's staking module focus on enhancing error handling across several key functions. Modifications were made to ensure that errors are not merely logged but are returned to the caller, enhancing the robustness and reliability of the codebase. This shift towards more explicit error handling aligns with best practices in software development, ensuring that potential issues can be caught and addressed more effectively.

Changes

File Path	Change Summary
x/staking/keeper/delegation.go x/staking/keeper/slash.go x/staking/keeper/validator.go	Enhanced error handling: Updated error handling in several methods to return errors instead of logging, using fmt.Errorf for formatted error messages and changing return types where necessary.
x/staking/go.mod	Short summary: Added two new replace directives in the go.mod file, pointing to cosmossdk.io/core and cosmossdk.io/x/tx.
x/staking/go.sum	Short summary: Updated dependencies including github.com/99designs/keyring, github.com/bufbuild/protocompile, github.com/danieljoos/wincred, and github.com/go-kit/kit.
x/staking/CHANGELOG.md	Short summary: Improved error handling in various methods, ensuring that errors are returned instead of causing panics. Additionally, hooks calls on specific functions now return errors instead of just logging.

Assessment against linked issues

Objective	Addressed	Explanation
Review changes between v0.50.0-beta-0 and v0.50.0-rc.0 in x/staking/keeper/validator.go (#17843)	✅
Understand why Keeper.RemoveValidator only logs an error without returning it (#17843)	❌	The change now includes enhanced error handling in Keeper.RemoveValidator, indicating a shift towards returning errors.
Determine if the absence of error return in Keeper.RemoveValidator is due to clearing old validator records (#17843)	❓	The updated code suggests a change in error handling approach, not explicitly tied to record clearing.
Highlight the discrepancy in error handling compared to other hooks like AfterValidatorBonded (#17843)	✅
Request input from @tac0turtle for insights on the observed behavior (#17843)	❌	No specific mention of reaching out for clarification in the provided information.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[julienrbrt]

lgtm, but can we get a changelog in x/staking/changelog as its a behavior change?

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between f783b24 and ec6efd0.

Files selected for processing (1)

• x/staking/go.mod (1 hunks)

Additional comments: 1

x/staking/go.mod (1)

• 171-172: The addition of replace directives for cosmossdk.io/core and cosmossdk.io/x/tx is noted. Ensure that these changes are temporary and meant to be removed once the modules are fully integrated or spun out. This approach is common in Go modules for local development or when working with modules that are in the process of being extracted or refactored. However, it's crucial to track these changes to avoid them being inadvertently merged into the main or release branches, as they can disrupt module resolution for anyone using this module as a dependency.

Verification successful

---

The search for documentation or comments regarding the temporary nature of the replace directives in the go.mod files has yielded results. The TODO comments indicating the intention to remove these directives post spinning out all modules were found in multiple go.mod files across the repository, including the x/staking/go.mod file in question. This confirms that there is a documented intention to remove these directives, aligning with the best practices for managing temporary module replacements in Go projects.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify if there's a tracking issue or documentation mentioning the temporary nature of these replace directives.
grep -R "TODO remove post spinning out all modules" . || echo "No tracking issue or documentation found for the replace directives."

Length of output: 527

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between ec6efd0 and c93b32a.

Files selected for processing (2)

• x/staking/go.mod (4 hunks)
• x/staking/go.sum (6 hunks)

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

• x/staking/go.mod

Additional comments: 4

x/staking/go.sum (4)

• 20-21: The update of github.com/99designs/keyring to v1.2.2 is noted. Ensure compatibility with this version.
• 75-76: The update of github.com/bufbuild/protocompile to v0.5.1 is noted. Verify that this version is compatible with the rest of the project's dependencies.
• 151-152: The update of github.com/danieljoos/wincred to v1.2.0 is noted. Ensure that this version does not introduce any breaking changes or incompatibilities.
• 227-228: The update of github.com/go-kit/kit to v0.13.0 is noted. Verify compatibility and check for any required changes in the codebase due to this update.