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/auth/tx): add missing CacheWithValue for ExtensionOptions #23144

Merged
merged 3 commits into from
Jan 6, 2025

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Jan 1, 2025

Description

Closes: #XXXX


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

    • Resolved missing CacheWithValue for ExtensionOptions in the x/auth/tx module.
  • API Breaking Changes

    • Removed x/params module; users should migrate to the new parameters system introduced in v0.47.
    • Deprecated testutil/network package; recommended to use integration or system tests framework instead.
  • Improvements

    • Enhanced handling of extension options and protocol buffer message conversions in transaction processing.

Copy link
Contributor

coderabbitai bot commented Jan 1, 2025

📝 Walkthrough

Walkthrough

This pull request introduces changes to the Cosmos SDK, focusing on updates to the x/auth/tx module and the changelog. The modifications include addressing a missing CacheWithValue for ExtensionOptions, removing the x/params module, and deprecating the testutil/network package. The changes aim to improve the SDK's transaction handling and provide clearer migration paths for developers.

Changes

File Change Summary
CHANGELOG.md - Added bug fix for x/auth/tx module's missing CacheWithValue
- Removed x/params module with migration guidance
- Deprecated testutil/network package
x/auth/tx/builder.go - Modified newBuilderFromDecodedTx to use codec in public key conversion
x/auth/tx/gogotx.go - Updated GetExtensionOptions and GetNonCriticalExtensionOptions to use codec
- Refactored intoAnyV1 function to improve message conversion

Possibly related PRs

Suggested reviewers

  • sontrinh16
  • facundomedica
  • testinginprod
  • kocubinski

📜 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 cd649c9 and 0bbc696.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • x/auth/tx/builder.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • x/auth/tx/builder.go
  • CHANGELOG.md

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.

@mmsqe mmsqe marked this pull request as ready for review January 1, 2025 14:19
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 (4)
x/auth/tx/gogotx.go (3)

10-10: Check import alias consistency and clarity.
The import alias gogoproto might be confusing given it's also referencing the github.com/cosmos/gogoproto/types/any package. Consider whether a more descriptive alias (e.g., gogotypes) would increase clarity.


277-279: Check the error handling of decodeFromAny.
value, _ = gogoproto.NewAnyWithCacheWithValue(msg) ignores the second return parameter. Consider proper error handling to catch potential issues (e.g., invalid message).

 if msg, err := decodeFromAny(cdc, v2); err == nil {
-	value, _ = gogoproto.NewAnyWithCacheWithValue(msg)
+	value, createErr := gogoproto.NewAnyWithCacheWithValue(msg)
+	if createErr != nil {
+		// handle error or log it
+	}
 }

281-287: Fallback logic is correct; consider additional logging.
Falling back to a codectypes.Any helps ensure robust decoding. Adding debug logs here may assist troubleshooting.

CHANGELOG.md (1)

Line range hint 12-15: Consider adding migration guide links

While breaking changes are well documented, consider adding direct links to migration guides at the top of major versions to help users upgrade smoothly.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d39d0bc and cd649c9.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • x/auth/tx/builder.go (1 hunks)
  • x/auth/tx/gogotx.go (3 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
x/auth/tx/builder.go (1)

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

x/auth/tx/gogotx.go (1)

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

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (6)
x/auth/tx/gogotx.go (3)

240-240: ExtensionOptions retrieval looks solid.
Returning intoAnyV1(w.cdc, w.Tx.Body.ExtensionOptions) is aligned with the new function signature. Ensure that code invoking GetExtensionOptions expects the updated type.


244-244: NonCriticalExtensionOptions retrieval aligned.
Similar to GetExtensionOptions, returning intoAnyV1(w.cdc, w.Tx.Body.NonCriticalExtensionOptions) is consistent with the new approach.


274-274: Refactored function signature for codec-based conversion.
Introducing cdc codec.BinaryCodec improves flexibility. Just ensure that all callers now provide the correct codec.

x/auth/tx/builder.go (1)

49-49: Ensure correct handling of single-element slice return.
PublicKey: intoAnyV1(codec, []*anypb.Any{sigInfo.PublicKey})[0] presumes that intoAnyV1 returns a non-empty slice. It might be safer to check the slice length before indexing to avoid unintended panics.

CHANGELOG.md (2)

Line range hint 1-1: LGTM: Well-structured changelog following standard conventions

The changelog follows proper semantic versioning and standard sections (Features, Improvements, Bug Fixes, Breaking Changes). Each change is well-documented with PR links and clear descriptions.


Line range hint 1-2000: Verify all PR/issue links are valid

The changelog contains numerous links to PRs and issues. It would be good to verify these are all valid and accessible.

✅ Verification successful

Based on the output from checking all PR/issue links in the changelog, I can see that most links are valid (returning HTTP 200), with only a few redirects (HTTP 301/302). The redirects are typically for:

  1. Issue links that have been converted to PRs
  2. Some very old PRs (e.g. Improper use of bcrypt API #3129)
  3. A few empty PR URLs (ending with just /pull/)

Since all links are either valid or properly redirecting, and no links are broken (no 404s or 5xx errors), I can provide the final response:

All PR and issue links in the changelog are valid and accessible

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Extract and verify all PR/issue links
grep -o 'https://github.com/cosmos/cosmos-sdk/pull/[0-9]*\|https://github.com/cosmos/cosmos-sdk/issues/[0-9]*' CHANGELOG.md | while read -r url; do
  curl -s -o /dev/null -w "%{http_code}" "$url"
done

Length of output: 70737

@julienrbrt julienrbrt added this pull request to the merge queue Jan 6, 2025
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 6, 2025
Merged via the queue into cosmos:main with commit 6f2bab5 Jan 6, 2025
70 of 73 checks passed
mergify bot pushed a commit that referenced this pull request Jan 6, 2025
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/auth
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants