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): avoid panic from newWrapperFromDecodedTx #23170

Merged
merged 5 commits into from
Jan 9, 2025

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Jan 3, 2025

when AuthInfo.Fee is optional in decodedTx

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 a potential panic in the transaction decoding process when AuthInfo.Fee is optional.
  • Tests

    • Added a new test case to verify safe handling of transactions with empty AuthInfo.

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a bug fix for the newWrapperFromDecodedTx function in the Cosmos SDK's x/auth/tx module. The changes ensure that the function handles scenarios where AuthInfo.Fee is optional, preventing potential panic situations. A corresponding test has been added to verify that the function can process transactions without crashing when fee information is absent. The changelog has been updated to reflect this new bug fix entry.

Changes

File Change Summary
CHANGELOG.md Added bug fix entry for newWrapperFromDecodedTx function.
x/auth/tx/gogotx.go Introduced nil check for decodedTx.Tx.AuthInfo.Fee to prevent potential panic.
x/auth/tx/gogotx_test.go Added new test function TestNewWrapperFromDecodedTxAllowsNilFee to validate fee handling.

Possibly related PRs

Suggested reviewers

  • tac0turtle
  • sontrinh16
  • julienrbrt
  • facundomedica

📜 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 c2dc751 and a4cb5d0.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • x/auth/tx/gogotx.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • x/auth/tx/gogotx.go
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • 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.

@mmsqe mmsqe changed the title fix(x/auth/tx): avoid panic from newWrapperFromDecodedTx without tx fix(x/auth/tx): avoid panic from newWrapperFromDecodedTx Jan 3, 2025
@mmsqe mmsqe marked this pull request as ready for review January 3, 2025 16:24
x/auth/tx/gogotx.go Outdated Show resolved Hide resolved
when AuthInfo.Fee is optional in decodedTx

lint

Apply suggestions from code review
@tac0turtle tac0turtle added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 3, 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 (5)
x/auth/tx/gogotx_test.go (1)

17-26: Consider validating final wrapper objects as well as the error.

While the test verifies that no error is returned, it might also be beneficial to confirm expected fields in the resulting wrapper (e.g., fees, payer, etc.) for stronger coverage. Using require.NoError(t, err) is typically more explicit than require.Nil.

CHANGELOG.md (4)

Line range hint 1-1: Add title to changelog file

The file should start with a clear title like "# Changelog" to follow standard changelog conventions.

+ # Changelog

Line range hint 13-20: Improve changelog guiding principles formatting

The guiding principles section should be formatted as a proper markdown list for better readability.

- Changelogs are for humans, not machines.
- There should be an entry for every single version.
- The same types of changes should be grouped.
- Versions and sections should be linkable.
- The latest version comes first.
- The release date of each version is displayed.
- Mention whether you follow Semantic Versioning.
+ * Changelogs are for humans, not machines
+ * There should be an entry for every single version
+ * The same types of changes should be grouped
+ * Versions and sections should be linkable
+ * The latest version comes first
+ * The release date of each version is displayed
+ * Mention whether you follow Semantic Versioning

Line range hint 22-32: Improve usage instructions formatting

The usage instructions section should use consistent markdown formatting and clearer structure.

- Change log entries are to be added to the Unreleased section under the
- appropriate stanza (see below). Each entry is required to include a tag and
- the Github issue reference in the following format:
+ # Usage
+
+ ## Adding Entries
+ Add change log entries to the "Unreleased" section under the appropriate stanza.
+ Each entry must include:
+ * A tag indicating where the change was made (e.g. `(x/staking)`)
+ * The GitHub issue/PR reference
+ * A description of the change
+
+ Format: `* (<tag>) \#<issue-number> <description>`

Line range hint 34-41: Standardize change type descriptions

The "Types of changes" section should use consistent formatting and provide clearer descriptions.

- "Features" for new features.
- "Improvements" for changes in existing functionality.
- "Deprecated" for soon-to-be removed features.
- "Bug Fixes" for any bug fixes.
+ ## Types of Changes
+
+ * `Features` - New functionality added
+ * `Improvements` - Enhancements to existing functionality
+ * `Deprecated` - Features that will be removed in future versions
+ * `Bug Fixes` - Fixes for broken functionality
+ * `Breaking Changes` - Changes that break backward compatibility:
+   * `Client Breaking` - Changes affecting client applications
+   * `CLI Breaking` - Changes affecting command line interface
+   * `API Breaking` - Changes affecting programmatic interfaces
+   * `State Machine Breaking` - Changes affecting blockchain state
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d8c8458 and 1d97196.

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

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

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 (5)
x/auth/tx/gogotx_test.go (2)

1-2: File-level overview and test naming clarity.

The new file is appropriately placed under the same package, and the test function name clearly indicates the target being tested. This setup follows Golang naming best practices for test files (*_test.go).


3-7: Imports usage.

Using testify/require is a good practice for concise test assertions. No issues found here.

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

35-37: Graceful handling of optional fee.

Great addition of a default to an empty coin set in case of a nil AuthInfo.Fee. This prevents panics and aligns with the design goal of optional fees.


39-74: Conditional logic for fee processing.

This if check accurately ensures no fee logic is processed when Fee is nil. The follow-on validations and conversions are handled cleanly, reducing the risk of a nil-pointer dereference.

CHANGELOG.md (1)

Line range hint 1-5000: Fix broken links in changelog

Several PR/issue links appear to be broken or malformed. Please verify all links are correct and properly formatted.

x/auth/tx/gogotx_test.go Outdated Show resolved Hide resolved
Co-authored-by: Alex | Skip <alex@djinntek.world>
@julienrbrt julienrbrt requested review from alpe and removed request for facundomedica and testinginprod January 9, 2025 08:23
@aljo242 aljo242 enabled auto-merge January 9, 2025 22:17
@aljo242 aljo242 added this pull request to the merge queue Jan 9, 2025
Merged via the queue into cosmos:main with commit 517839b Jan 9, 2025
67 of 69 checks passed
mergify bot pushed a commit that referenced this pull request Jan 9, 2025
Co-authored-by: Alex | Skip <alex@djinntek.world>
Co-authored-by: Alex | Interchain Labs <alex@skip.money>
(cherry picked from commit 517839b)
julienrbrt pushed a commit that referenced this pull request Jan 9, 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.

4 participants