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): add an option to encode maps using amino json (ref #23513) #23539

Merged
merged 3 commits into from
Jan 28, 2025

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 28, 2025

Follow-up of #23513

Afterwards i'll cherry-pick this in x/tx v0.13 after Noble's request. v0.13 is present in release/v0.50.x branch, hence the backport to that branch. v1 is tagged from main.
Then I'll bump in autocli.


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

Release Notes

  • New Features

    • Added map marshalling support to the Amino JSON encoder
    • Improved handling of map and list types during JSON marshaling
  • Testing

    • Enhanced test coverage for map marshalling functionality
    • Removed debugging print statements from existing tests
  • Changelog

    • Updated changelog with new versions v1.1.0 and v0.13.7

These updates improve the robustness and flexibility of the JSON encoding process, particularly for map and list data types.

@julienrbrt julienrbrt requested a review from a team as a code owner January 28, 2025 14:57
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

📝 Walkthrough

Walkthrough

This pull request introduces changes to the x/tx module, focusing on enhancing the Amino JSON encoder's map marshalling capabilities. The modifications include updating the changelog with new version entries for v1.1.0 and v0.13.7, and improving the marshalling logic in the json_marshal.go file. A new test function is added to validate the map marshalling behavior, ensuring robust handling of map types during JSON encoding.

Changes

File Change Summary
x/tx/CHANGELOG.md Added version entries for v1.1.0 and v0.13.7 on 2025-01-28, referencing map marshalling support
x/tx/signing/aminojson/json_marshal.go Enhanced map and list marshalling logic with validity checks and null handling
x/tx/signing/aminojson/json_marshal_test.go Added TestMarshalMappings test function; removed debug print statements

Sequence Diagram

sequenceDiagram
    participant Encoder
    participant Writer
    participant MapData
    
    Encoder->>Encoder: Check map validity
    alt Map is valid
        Encoder->>MapData: Construct map data
        MapData->>Writer: Marshal key-value pairs
    else Map is invalid
        Encoder->>Writer: Write null
    end
Loading

Possibly related PRs

Suggested reviewers

  • julienrbrt
  • aljo242
  • tac0turtle
✨ 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.50.x PR scheduled for inclusion in the v0.50's next stable release label Jan 28, 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 (1)
x/tx/signing/aminojson/json_marshal.go (1)

245-256: Robust implementation with room for optimization.

The changes correctly handle invalid map states and provide proper null handling. Consider using a pre-allocated capacity for the map to optimize memory allocation.

-mapData := make(map[string]interface{})
+mapData := make(map[string]interface{}, val.Len())
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 33442d9 and c69f27a.

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

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

x/tx/signing/aminojson/json_marshal_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/tx/signing/aminojson/json_marshal.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 (13)
  • GitHub Check: tests (03)
  • GitHub Check: tests (02)
  • GitHub Check: tests (01)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-integration
  • GitHub Check: test-system-v2
  • GitHub Check: build (arm64)
  • GitHub Check: build (amd64)
  • GitHub Check: Analyze
  • GitHub Check: golangci-lint
  • GitHub Check: Summary
🔇 Additional comments (2)
x/tx/signing/aminojson/json_marshal_test.go (1)

416-440: Well-structured test implementation!

The test covers both valid and invalid cases for map marshalling, with clear assertions and error checks.

x/tx/CHANGELOG.md (1)

36-39: Well-documented changelog entries!

The version entries are properly formatted, follow semantic versioning, and include appropriate PR references.

Also applies to: 64-67

@julienrbrt julienrbrt added this pull request to the merge queue Jan 28, 2025
Merged via the queue into main with commit aef1a2a Jan 28, 2025
70 of 71 checks passed
@julienrbrt julienrbrt deleted the julien/fix branch January 28, 2025 17:21
mergify bot pushed a commit that referenced this pull request Jan 28, 2025
…#23539)

Co-authored-by: Alex | Interchain Labs <[email protected]>
(cherry picked from commit aef1a2a)

# Conflicts:
#	x/tx/CHANGELOG.md
#	x/tx/signing/aminojson/json_marshal.go
#	x/tx/signing/aminojson/json_marshal_test.go
julienrbrt added a commit that referenced this pull request Jan 28, 2025
@julienrbrt julienrbrt mentioned this pull request Jan 28, 2025
12 tasks
alpe added a commit that referenced this pull request Jan 30, 2025
* main: (61 commits)
  build(deps): Bump cosmossdk.io/x/tx from 1.0.1 to 1.1.0 (#23547)
  feat(client/v2): add map support (#23544)
  fix(db): Fix pebbleDB integration (#23552)
  build(deps): Bump buf.build/gen/go/cometbft/cometbft/protocolbuffers/go from 1.36.3-20241120201313-68e42a58b301.1 to 1.36.4-20241120201313-68e42a58b301.1 in /api (#23520)
  build(deps): Bump github.com/golang/glog from 1.2.3 to 1.2.4 in /tools/hubl (#23541)
  fix(x/tx): add an option to encode maps using amino json (ref #23513) (#23539)
  build(deps): Bump cosmossdk.io/collections from 1.0.0 to 1.1.0 (#23534)
  build(deps): Bump github.com/bytedance/sonic from 1.12.7 to 1.12.8 in /log (#23516)
  chore: fix changelog for `v0.52.0-rc.2` (#23502)
  build(deps): Bump google.golang.org/protobuf from 1.36.3 to 1.36.4 in /x/upgrade (#23512)
  chore(collections): bring in `protocodec` in collections directly (#23515)
  feat(x/tx): add an option to encode maps using amino json (#23513)
  fix(codec): provide legacy amino og type (#23504)
  chore: remove unecessary SDKGasMeter impl (#23503)
  refactor: replace `golang.org/x/exp` with stdlib (#23501)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /tools/cosmovisor (#23496)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /store (#23494)
  build(deps): Bump github.com/hashicorp/go-plugin from 1.6.2 to 1.6.3 in /store (#23493)
  ci: Fix Ci job target (#23500)
  feat(server/v2): add swagger server component (#23486)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/tx
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants