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(x/staking): avoid overriding error #23076

Merged
merged 2 commits into from
Jan 6, 2025
Merged

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Dec 24, 2024

Description

This pr fixes an error overwrite that was happening.


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 for unbonding time retrieval by providing more context in error reporting.
  • Style

    • Minor adjustments to comments and formatting for better readability.

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a modification in the x/staking/keeper/delegation.go file, specifically focusing on error handling within the getBeginInfo method. The change involves replacing the error variable err with err2 when calling k.UnbondingTime(ctx), allowing the original err to be preserved for error reporting. The method now returns a combined error using errors.Join(err, err2) if both errors occur. The overall logic of the method remains unchanged, continuing to determine the completion time and height of a redelegation based on the validator's status.

Changes

File Change Summary
x/staking/keeper/delegation.go - Replaced err with err2 in getBeginInfo method for error handling
- Updated error return logic to use errors.Join(err, err2)

Suggested labels

C:x/staking

Suggested reviewers

  • kocubinski
  • sontrinh16
  • testinginprod

Possibly related PRs

  • docs: fix typos #23116: This PR modifies the variable name remaingSlashAmount to remainingSlashAmount in the x/staking/README.md, which is related to the staking module where the main PR's changes occur.
  • docs: fix typos #23152: This PR corrects the term notBondedLockedAmout to notBondedLockedAmount in the documentation for the lockup account types, which is also relevant to the staking context in the main PR.

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e210c1c and 5884fc2.

📒 Files selected for processing (1)
  • x/staking/keeper/delegation.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • x/staking/keeper/delegation.go
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: tests (00)
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: Summary

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

Copy link
Contributor

@tac0turtle your pull request is missing a changelog!

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: 1

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2f8d and e210c1c.

📒 Files selected for processing (1)
  • x/staking/keeper/delegation.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
x/staking/keeper/delegation.go (1)

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

Comment on lines +861 to +862
unbondingTime, err2 := k.UnbondingTime(ctx)
if err2 != nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Correct the returned error variable to match the renamed one.

Currently, the code captures the error in err2 but returns the outer err, which could be uninitialized or stale. To ensure we return the right error, align the return statement with the newly introduced variable:

- unbondingTime, err2 := k.UnbondingTime(ctx)
- if err2 != nil {
-     return completionTime, height, false, err
- }
+ unbondingTime, err := k.UnbondingTime(ctx)
+ if err != nil {
+     return completionTime, height, false, err
+ }

Committable suggestion skipped: line range outside the PR's diff.

@julienrbrt julienrbrt changed the title fix(staking): avoid overriding error fix(x/staking): avoid overriding error Dec 28, 2024
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 6, 2025
@julienrbrt julienrbrt enabled auto-merge January 6, 2025 09:45
@julienrbrt julienrbrt added this pull request to the merge queue Jan 6, 2025
Merged via the queue into main with commit 65971ff Jan 6, 2025
74 of 75 checks passed
@julienrbrt julienrbrt deleted the marko/avoid_overiding_error branch January 6, 2025 10:01
mergify bot pushed a commit that referenced this pull request Jan 6, 2025
Co-authored-by: Julien Robert <[email protected]>
(cherry picked from commit 65971ff)
julienrbrt pushed a commit that referenced this pull request Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/staking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants