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

chore: Review feedback #23465

Merged
merged 1 commit into from
Jan 20, 2025
Merged

chore: Review feedback #23465

merged 1 commit into from
Jan 20, 2025

Conversation

alpe
Copy link
Contributor

@alpe alpe commented Jan 20, 2025

Description

Follow up on #23462


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 staking module's genesis initialization and export processes
    • Enhanced logging of store comparison mismatches during testing

The changes focus on more robust error tracking and comprehensive logging mechanisms, which will help developers identify and diagnose potential issues more effectively during system initialization and testing.

@alpe alpe requested review from JulianToledano, ziscky, a team and julienrbrt as code owners January 20, 2025 10:15
Copy link
Contributor

coderabbitai bot commented Jan 20, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to two files: simapp/v2/sim_test_utils.go and x/staking/keeper/genesis.go. In the first file, a break statement is removed from the AssertEqualStores function, allowing all store mismatches to be logged instead of stopping at the first occurrence. In the staking keeper's genesis methods, error handling is enhanced for Walk function calls, with more descriptive error reporting and simplified parameter declarations.

Changes

File Change Summary
simapp/v2/sim_test_utils.go Removed break statement in AssertEqualStores to log all store mismatches
x/staking/keeper/genesis.go Added error handling for Walk function calls in InitGenesis and ExportGenesis methods

Suggested Labels

C:server/v2

Suggested Reviewers

  • sontrinh16
  • kocubinski
  • testinginprod
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 20, 2025
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

🧹 Nitpick comments (2)
x/staking/keeper/genesis.go (2)

Line range hint 364-378: LGTM! Consider using errors.Wrap for better error context.

The error handling implementation is solid with descriptive messages. However, consider using errors.Wrap from github.com/pkg/errors for better error context and stack traces.

-		return nil, fmt.Errorf("cons addrs to validator ident: %w", err)
+		return nil, errors.Wrap(err, "cons addrs to validator ident")

Line range hint 380-394: Consider extracting common address conversion logic.

The address conversion logic is duplicated between both Walk implementations. Consider extracting it into a helper method to improve maintainability and reduce duplication.

+func (k Keeper) consensusAddressToString(bz []byte, label string) (string, error) {
+    addr, err := k.consensusAddressCodec.BytesToString(bz)
+    if err != nil {
+        return "", fmt.Errorf("decode %s address %X: %w", label, bz, err)
+    }
+    return addr, nil
+}

 err = k.OldToNewConsAddrMap.Walk(ctx, nil, func(oldBz, newBz []byte) (stop bool, err error) {
-    oldAddr, err2 := k.consensusAddressCodec.BytesToString(oldBz)
+    oldAddr, err2 := k.consensusAddressToString(oldBz, "old")
     if err2 != nil {
-        return true, fmt.Errorf("decode old address %X: %w", oldBz, err2)
+        return true, err2
     }
-    newAddr, err2 := k.consensusAddressCodec.BytesToString(newBz)
+    newAddr, err2 := k.consensusAddressToString(newBz, "new")
     if err2 != nil {
-        return true, fmt.Errorf("decode new address %X: %w", newBz, err2)
+        return true, err2
     }
     // ... rest of the code
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5359c8f and 0c3b6e8.

📒 Files selected for processing (2)
  • simapp/v2/sim_test_utils.go (0 hunks)
  • x/staking/keeper/genesis.go (3 hunks)
💤 Files with no reviewable changes (1)
  • simapp/v2/sim_test_utils.go
🧰 Additional context used
📓 Path-based instructions (1)
x/staking/keeper/genesis.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: golangci-lint
  • GitHub Check: Summary

@alpe alpe added this pull request to the merge queue Jan 20, 2025
Merged via the queue into main with commit 66a766b Jan 20, 2025
80 of 81 checks passed
@alpe alpe deleted the alex/23462_feedback branch January 20, 2025 12:11
mergify bot pushed a commit that referenced this pull request Jan 20, 2025
(cherry picked from commit 66a766b)

# Conflicts:
#	simapp/v2/sim_test_utils.go
@mergify mergify bot mentioned this pull request Jan 20, 2025
12 tasks
julienrbrt added a commit that referenced this pull request Jan 20, 2025
Co-authored-by: Alexander Peters <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
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.

4 participants