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/tx): don't shadow Amino marshalling error messages #19955

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

Pitasi
Copy link
Contributor

@Pitasi Pitasi commented Apr 4, 2024

Description

A minor thing but it took me a while to figure out where the problem was when marshalling a message of mine.

The error (trimmed for readability) was:

cannot marshal response pagination:{total:1} [...]: unexpected end of JSON input

While digging in the code I found that the real Amino error was not being considered, and buf.Bytes() was being tried to use anyway, but only when indenting the response.

In fact, after trying the same query from CLI with --no-indent, I got the real error:

cannot marshal response pagination:{total:1} [...]: field identifier within a oneof must have the amino.oneof_type_name option set

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

  • Bug Fixes
    • Improved error handling in transactions to ensure clearer error messages are displayed, enhancing user experience during transaction processing.

@Pitasi Pitasi requested a review from a team as a code owner April 4, 2024 13:45
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Walkthrough

Walkthrough

The recent update focuses on enhancing error handling and interoperability in the system. A significant bug fix was made to ensure that errors related to Amino marshalling are properly reported, preventing their shadowing. Additionally, the system has transitioned to a hybrid resolver approach, moving away from relying solely on the protov2 registry. This change aims to improve the system's flexibility and efficiency in processing transactions.

Changes

File(s) Change Summary
x/tx/CHANGELOG.md Bug fix for Amino marshalling error message shadowing and adoption of a hybrid resolver.
x/tx/signing/aminojson/.../json_marshal.go Updated error handling in Marshal method to handle indentation errors and improve error response.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.
  • Please see the configuration documentation for more information.
  • 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

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.

@Pitasi Pitasi force-pushed the fix-shadowed-error-msg-x-tx branch from 9be102d to bff9d2c Compare April 4, 2024 13:46
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

Review Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between edd1c71 and bff9d2c.
Files selected for processing (2)
  • x/tx/CHANGELOG.md (1 hunks)
  • x/tx/signing/aminojson/json_marshal.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/tx/signing/aminojson/json_marshal.go
Additional Context Used
Path-based Instructions (1)
x/tx/CHANGELOG.md (1)

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

Additional comments not posted (1)
x/tx/CHANGELOG.md (1)

44-44: Ensure the description under "Bug Fixes" clearly explains the impact of the fix.

While the entry for PR #19955 under "Bug Fixes" is concise, consider expanding it to briefly describe how the fix improves error message clarity during Amino marshalling. This will provide better context for readers.

@github-actions github-actions bot added the C:x/tx label Apr 4, 2024
@tac0turtle tac0turtle added this pull request to the merge queue Apr 4, 2024
Merged via the queue into cosmos:main with commit 15ad85d Apr 4, 2024
61 of 64 checks passed
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 8, 2024
* main: (45 commits)
  build(deps): Bump github.com/decred/dcrd/dcrec/secp256k1/v4 from 4.2.0 to 4.3.0 (cosmos#19913)
  build(deps): Bump google.golang.org/grpc from 1.62.1 to 1.63.0 (cosmos#19929)
  test(types/address): add additional unit tests for address.LengthPrefix and a… (cosmos#19964)
  refactor(x/bank)!: remove Address.String() (cosmos#19954)
  build(deps): Bump github.com/prometheus/common from 0.51.1 to 0.52.2 (cosmos#19930)
  fix(x/epochs): Fix init genesis (cosmos#19958)
  feat(core,runtime): transaction service (exec mode) (cosmos#19953)
  fix(x/authz): non utf-8 characters in logs (cosmos#19923)
  build(deps): Bump golang.org/x/crypto from 0.21.0 to 0.22.0 (cosmos#19960)
  chore: fix spelling errors (cosmos#19957)
  fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955)
  refactor(types): loosen module.AppModule interface (cosmos#19951)
  feat(core): add `TxValidator` interface (cosmos#19950)
  build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 in /x/epochs (cosmos#19947)
  feat(x/epochs): upstream osmosis epoch module (cosmos#19697)
  build(deps): Bump bufbuild/buf-setup-action from 1.30.0 to 1.30.1 (cosmos#19928)
  refactor(x/genutil)!: remove Address.String() (cosmos#19926)
  docs(x/mint): Fix inconsistency in mint docs  (cosmos#19915)
  build(deps): Bump github.com/regen-network/gocuke from 1.1.0 to 1.1.1 in /orm (cosmos#19920)
  feat: Integrate grpc configuration into client.toml (cosmos#19905)
  ...
mmsqe pushed a commit to mmsqe/cosmos-sdk that referenced this pull request Sep 26, 2024
mmsqe added a commit to crypto-org-chain/cosmos-sdk that referenced this pull request Sep 27, 2024
)

* fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955)

* use directly instead of cast

---------

Co-authored-by: Antonio Pitasi <[email protected]>
@yihuang yihuang added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Oct 7, 2024
mergify bot pushed a commit that referenced this pull request Oct 7, 2024
(cherry picked from commit 15ad85d)

# Conflicts:
#	x/tx/CHANGELOG.md
@yihuang yihuang removed the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Oct 7, 2024
dudong2 pushed a commit to b-harvest/cosmos-sdk that referenced this pull request Oct 30, 2024
…osmos#808)

* fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955)

* use directly instead of cast

---------

Co-authored-by: Antonio Pitasi <[email protected]>
dudong2 added a commit to b-harvest/cosmos-sdk that referenced this pull request Nov 6, 2024
* feat(x/tx): support bytes field as signer (cosmos#21850)

* Problem: multisig account failed on threshold encode after send tx   (cosmos#808)

* fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955)

* use directly instead of cast

---------

Co-authored-by: Antonio Pitasi <[email protected]>

* feat: Fix datarace

---------

Co-authored-by: mmsqe <[email protected]>
Co-authored-by: Antonio Pitasi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants